diff --git a/main/docs.json b/main/docs.json index 8c7a859d0..f76410813 100644 --- a/main/docs.json +++ b/main/docs.json @@ -703,11 +703,11 @@ "group": "Enterprise Identity Providers", "pages": [ { - "group": "Okta", - "pages": [ - "docs/authenticate/identity-providers/okta", - "docs/authenticate/identity-providers/enterprise-identity-providers/okta/express-configuration" - ] + "group": "Okta", + "pages": [ + "docs/authenticate/identity-providers/okta", + "docs/authenticate/identity-providers/enterprise-identity-providers/okta/express-configuration" + ] }, { "group": "Connect Your App to Active Directory using LDAP", @@ -1242,6 +1242,703 @@ "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": [ + { + "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/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" + ] + } + ] + }, + { + "group": "Interfaces", + "pages": [ + "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/Connection", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ContinueWithCodeOptionPayload", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CredentialResponse", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CustomOptions", + "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/FlattenedTheme", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Identifier", + "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/PhonePrefix", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResendCodeOptionsPayload", + "docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResendControl", + "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/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/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/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/WebAuthnErrorDetails", + "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" + ] + }, + { + "group": "Types", + "pages": [ + "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" + ] + } + ] + }, + { + "group": "auth0-acul-react", + "pages": [ + { + "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", + "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": "Screens", + "pages": [ + "docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Screens/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" + ] + } + ] + }, + { + "group": "Types", + "pages": [ + "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/Organizations", + "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/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/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" + ] + } + ] + } + ] } ] } @@ -24211,19 +24908,19 @@ "destination": "/docs/secure/security-guidance/measures-against-app-impersonation" }, { - "source": "/docs/secure/tokens/token-vault/configure-access-token-exchange-with-token-vault", + "source": "/docs/secure/tokens/token-vault/configure-access-token-exchange-with-token-vault", "destination": "/docs/secure/tokens/token-vault/configure-token-vault" }, { - "source": "/docs/secure/tokens/token-vault/configure-refresh-token-exchange-with-token-vault", + "source": "/docs/secure/tokens/token-vault/configure-refresh-token-exchange-with-token-vault", "destination": "/docs/secure/tokens/token-vault/configure-token-vault" }, { - "source": "/docs/secure/tokens/token-vault/call-apis-with-token-vault", + "source": "/docs/secure/tokens/token-vault/call-apis-with-token-vault", "destination": "/docs/secure/tokens/token-vault/refresh-token-exchange-with-token-vault" }, { - "source": "/docs/get-started/authentication-and-authorization-flow/client-initiated-backchannel-authentication-flow/user-authentication-with-ciba", + "source": "/docs/get-started/authentication-and-authorization-flow/client-initiated-backchannel-authentication-flow/user-authentication-with-ciba", "destination": "/docs/get-started/authentication-and-authorization-flow/client-initiated-backchannel-authentication-flow/mobile-push-notifications-with-ciba" } ] 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..44cb81746 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/AcceptInvitation.mdx @@ -0,0 +1,189 @@ +--- +title: "AcceptInvitation" +--- + +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. + + + +```ts Example +import AcceptInvitation from '@auth0/auth0-acul-js/accept-invitation'; + +const acceptInvitation = new AcceptInvitation(); +await acceptInvitation.acceptInvitation(); +``` + + +- Extends `BaseContext` + +- Implements [`AcceptInvitationMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/AcceptInvitationMembers) + +## Constructors + + +{/*> **new AcceptInvitation**(): `AcceptInvitation`*/} + +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. + +- Returns `AcceptInvitation` + +- Overrides `BaseContext.constructor` + + +## Properties + +BrandingMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#branding) + +- Inherited from `BaseContext.branding` + + + +ClientMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#client) + +- Inherited from `BaseContext.client` + + + +OrganizationMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#organization) + +- Inherited from `BaseContext.organization` + + + +PromptMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#prompt) + +- Inherited from `BaseContext.prompt` + + + +ScreenMembersOnAcceptInvitation}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#screen) + +- Overrides `BaseContext.screen` + + + +TenantMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#tenant) + +- Inherited from `BaseContext.tenant` + + + +TransactionMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#transaction) + +- Inherited from `BaseContext.transaction` + + + +UntrustedDataMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#untrusteddata) + +- Inherited from `BaseContext.untrustedData` + + + +UserMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#user) + +- Inherited from `BaseContext.user` + + + + +{/*> `static` **screenIdentifier**: `string` = `ScreenIds.ACCEPT_INVITATION`*/} + +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 `BaseContext.screenIdentifier` + + +## Methods + + +{/*> **acceptInvitation**(`payload?`): `Promise`\<`void`\>*/} + +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. + + +CustomOptions}> +[`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CustomOptions) + +Optional custom options to include with the request. + + + +- Returns `Promise`\<`void`\> + +```typescript Example +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#acceptinvitation) + + + +Error[]}> +{/*> **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/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. + +- 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` + \ 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..9373d9f1c --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/AculError.mdx @@ -0,0 +1,54 @@ +--- +title: "AculError" +--- + +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 + +## 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 + + +{/*> **new AculError**(`message`, `field?`): `AculError`*/} + +Defined in: [src/utils/errors.ts:14](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/utils/errors.ts#L14) + + + +The error message. + + +The optional field associated with the error. + + +- Returns `AculError` + +- Overrides `Error.constructor` + + +## Properties + + +{/*> `readonly` **code**: `string`*/} + +Defined in: [src/utils/errors.ts:11](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/utils/errors.ts#L11) + + + + +{/*> `readonly` `optional` **field**: `string`*/} + +Defined in: [src/utils/errors.ts:12](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/utils/errors.ts#L12) + \ 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..d65042917 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/Auth0ServerError.mdx @@ -0,0 +1,49 @@ +--- +title: "Auth0ServerError" +--- + +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 + + +- Extends [`AculError`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/AculError) + +## Constructors + + +{/*> **new Auth0ServerError**(`message`, `field?`): `Auth0ServerError`*/} + +Defined in: [src/utils/errors.ts:66](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/utils/errors.ts#L66) + + + +The error message. + + +The optional field associated with the error. + + +- 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#constructor) + + +## Properties + + +{/*> `readonly` **code**: `"AUTH0_SERVER_ERROR"` = `'AUTH0_SERVER_ERROR'`*/} + +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 [`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#code) + + + + +{/*> `readonly` `optional` **field**: `string`*/} + +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 [`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#field) + \ 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..885986871 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/Consent.mdx @@ -0,0 +1,273 @@ +--- +title: "Consent" +--- + +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 + + + +```ts Example +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); + } +}; +``` + + +- Extends `BaseContext` + +- Implements [`ConsentMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ConsentMembers) + +## Constructors + + +{/*> **new Consent**(): `Consent`*/} + +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 +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` + + +## Properties + +BrandingMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#branding) + +- Inherited from `BaseContext.branding` + + + +ClientMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#client) + +- Inherited from `BaseContext.client` + + + +OrganizationMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#organization) + +- Inherited from `BaseContext.organization` + + + +PromptMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#prompt) + +- Inherited from `BaseContext.prompt` + + + +ScreenMembersOnConsent}> +{/*> **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/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 +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#screen) + +- Overrides `BaseContext.screen` + + + +TenantMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#tenant) + +- Inherited from `BaseContext.tenant` + + + +TransactionMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#transaction) + +- Inherited from `BaseContext.transaction` + + + +UntrustedDataMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#untrusteddata) + +- Inherited from `BaseContext.untrustedData` + + + +UserMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#user) + +- Inherited from `BaseContext.user` + + + + +{/*> `static` **screenIdentifier**: `string` = `ScreenIds.CONSENT`*/} + +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 `BaseContext.screenIdentifier` + + +## Methods + + +{/*> **accept**(`payload?`): `Promise`\<`void`\>*/} + +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=` endpoint +with `action: "accept"`. The transaction state is automatically included in both the +URL query parameter and the form body. + + +CustomOptions}> +[`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. + + + +- 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. + +```typescript Example +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#accept) + + + + +{/*> **deny**(`payload?`): `Promise`\<`void`\>*/} + +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=` endpoint +with `action: "deny"`. The transaction state is automatically included in both the +URL query parameter and the form body. + + +CustomOptions}> +[`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. + + + +- 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`. + +```typescript Example +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#deny) + + + +Error[]}> +{/*> **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/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. + +- 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` + \ 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..baf87bf2a --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/CustomizedConsent.mdx @@ -0,0 +1,284 @@ +--- +title: "CustomizedConsent" +--- + +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 + + + +```typescript Example +// 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 + + +{/*> **new CustomizedConsent**(): `CustomizedConsent`*/} + +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 +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` + + +## Properties + +BrandingMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#branding) + +- Inherited from `BaseContext.branding` + + + +ClientMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#client) + +- Inherited from `BaseContext.client` + + + +OrganizationMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#organization) + +- Inherited from `BaseContext.organization` + + + +PromptMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#prompt) + +- Inherited from `BaseContext.prompt` + + + +ScreenMembersOnCustomizedConsent}> +{/*> **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/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`. + +- 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#screen) + +- Overrides `BaseContext.screen` + + + +TenantMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#tenant) + +- Inherited from `BaseContext.tenant` + + + +TransactionMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#transaction) + +- Inherited from `BaseContext.transaction` + + + +UntrustedDataMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#untrusteddata) + +- Inherited from `BaseContext.untrustedData` + + + +UserMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#user) + +- Inherited from `BaseContext.user` + + + + +{/*> `readonly` `static` **screenIdentifier**: `string` = `ScreenIds.CUSTOMIZED_CONSENT`*/} + +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 +class is instantiated in the correct screen context. + +- Overrides `BaseContext.screenIdentifier` + + +## Methods + + +{/*> **accept**(`payload?`): `Promise`\<`void`\>*/} + +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=` endpoint +with `action: "accept"`. The transaction state is automatically included in both the +URL query parameter and the form body. + + +CustomOptions}> +[`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. + + + +- 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#accept) + + + + +{/*> **deny**(`payload?`): `Promise`\<`void`\>*/} + +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=` endpoint +with `action: "deny"`. The transaction state is automatically included in both the +URL query parameter and the form body. + + +CustomOptions}> +[`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. + + + +- 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#deny) + + + +Error[]}> +{/*> **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/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. + +- 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` + \ 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..e305c5d75 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/DeviceCodeActivation.mdx @@ -0,0 +1,205 @@ +--- +title: "DeviceCodeActivation" +--- + +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. + + + +```ts Example +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); + } +} +``` + + +- Extends `BaseContext` + +- Implements [`DeviceCodeActivationMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/DeviceCodeActivationMembers) + +## Constructors + + +{/*> **new DeviceCodeActivation**(): `DeviceCodeActivation`*/} + +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. + +- Returns `DeviceCodeActivation` + +- Overrides `BaseContext.constructor` + + +## Properties + +BrandingMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#branding) + +- Inherited from `BaseContext.branding` + + + +ClientMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#client) + +- Inherited from `BaseContext.client` + + + +OrganizationMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#organization) + +- Inherited from `BaseContext.organization` + + + +PromptMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#prompt) + +- Inherited from `BaseContext.prompt` + + + +ScreenMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#screen) + +- Inherited from `BaseContext.screen` + + + +TenantMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#tenant) + +- Inherited from `BaseContext.tenant` + + + +TransactionMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#transaction) + +- Inherited from `BaseContext.transaction` + + + +UntrustedDataMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#untrusteddata) + +- Inherited from `BaseContext.untrustedData` + + + +UserMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#user) + +- Inherited from `BaseContext.user` + + + + +{/*> `static` **screenIdentifier**: `string` = `ScreenIds.DEVICE_CODE_ACTIVATION`*/} + +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 `BaseContext.screenIdentifier` + + +## Methods + + +{/*> **continue**(`payload`): `Promise`\<`void`\>*/} + +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. + + +DeviceCodeActivationContinueOptions}> +[`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. + + + +- Returns `Promise`\<`void`\> + +A promise that resolves when the code is successfully submitted. + +```typescript Example +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#continue) + + + +Error[]}> +{/*> **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/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. + +- 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` + \ 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..eac9e3737 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/DeviceCodeActivationAllowed.mdx @@ -0,0 +1,152 @@ +--- +title: "DeviceCodeActivationAllowed" +--- + +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. + + +- Extends `BaseContext` + +- Implements [`DeviceCodeActivationAllowedMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/DeviceCodeActivationAllowedMembers) + +## Constructors + + +{/*> **new DeviceCodeActivationAllowed**(): `DeviceCodeActivationAllowed`*/} + +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. + +- Returns `DeviceCodeActivationAllowed` + +- Overrides `BaseContext.constructor` + + +## Properties + +BrandingMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#branding) + +- Inherited from `BaseContext.branding` + + + +ClientMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#client) + +- Inherited from `BaseContext.client` + + + +OrganizationMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#organization) + +- Inherited from `BaseContext.organization` + + + +PromptMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#prompt) + +- Inherited from `BaseContext.prompt` + + + +ScreenMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#screen) + +- Inherited from `BaseContext.screen` + + + +TenantMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#tenant) + +- Inherited from `BaseContext.tenant` + + + +TransactionMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#transaction) + +- Inherited from `BaseContext.transaction` + + + +UntrustedDataMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#untrusteddata) + +- Inherited from `BaseContext.untrustedData` + + + +UserMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#user) + +- Inherited from `BaseContext.user` + + + + +{/*> `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/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/screens/device-code-activation-allowed/index.ts#L11) + +- Overrides `BaseContext.screenIdentifier` + + +## Methods + +Error[]}> +{/*> **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/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. + +- 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` + \ 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..3559662ea --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/DeviceCodeActivationDenied.mdx @@ -0,0 +1,152 @@ +--- +title: "DeviceCodeActivationDenied" +--- + +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. + + +- Extends `BaseContext` + +- Implements [`DeviceCodeActivationDeniedMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/DeviceCodeActivationDeniedMembers) + +## Constructors + + +{/*> **new DeviceCodeActivationDenied**(): `DeviceCodeActivationDenied`*/} + +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. + +- Returns `DeviceCodeActivationDenied` + +- Overrides `BaseContext.constructor` + + +## Properties + +BrandingMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#branding) + +- Inherited from `BaseContext.branding` + + + +ClientMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#client) + +- Inherited from `BaseContext.client` + + + +OrganizationMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#organization) + +- Inherited from `BaseContext.organization` + + + +PromptMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#prompt) + +- Inherited from `BaseContext.prompt` + + + +ScreenMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#screen) + +- Inherited from `BaseContext.screen` + + + +TenantMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#tenant) + +- Inherited from `BaseContext.tenant` + + + +TransactionMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#transaction) + +- Inherited from `BaseContext.transaction` + + + +UntrustedDataMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#untrusteddata) + +- Inherited from `BaseContext.untrustedData` + + + +UserMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#user) + +- Inherited from `BaseContext.user` + + + + +{/*> `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/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/screens/device-code-activation-denied/index.ts#L11) + +- Overrides `BaseContext.screenIdentifier` + + +## Methods + +Error[]}> +{/*> **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/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. + +- 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` + \ 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..d2e6ee898 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/DeviceCodeConfirmation.mdx @@ -0,0 +1,217 @@ +--- +title: "DeviceCodeConfirmation" +--- + +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. + + + +```ts Example +import DeviceCodeConfirmation from '@auth0/auth0-acul-js/device-code-confirmation'; + +const deviceCodeConfirmation = new DeviceCodeConfirmation(); +await deviceCodeConfirmation.confirm(); +``` + + +- Extends `BaseContext` + +- Implements [`DeviceCodeConfirmationMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/DeviceCodeConfirmationMembers) + +## Constructors + + +{/*> **new DeviceCodeConfirmation**(): `DeviceCodeConfirmation`*/} + +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. + +- Returns `DeviceCodeConfirmation` + +- Overrides `BaseContext.constructor` + + +## Properties + +BrandingMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#branding) + +- Inherited from `BaseContext.branding` + + + +ClientMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#client) + +- Inherited from `BaseContext.client` + + + +OrganizationMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#organization) + +- Inherited from `BaseContext.organization` + + + +PromptMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#prompt) + +- Inherited from `BaseContext.prompt` + + + +ScreenMembersOnDeviceCodeConfirmation}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#screen) + +- Overrides `BaseContext.screen` + + + +TenantMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#tenant) + +- Inherited from `BaseContext.tenant` + + + +TransactionMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#transaction) + +- Inherited from `BaseContext.transaction` + + + +UntrustedDataMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#untrusteddata) + +- Inherited from `BaseContext.untrustedData` + + + +UserMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#user) + +- Inherited from `BaseContext.user` + + + + +{/*> `static` **screenIdentifier**: `string` = `ScreenIds.DEVICE_CODE_CONFIRMATION`*/} + +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 `BaseContext.screenIdentifier` + + +## Methods + + +{/*> **cancel**(`payload?`): `Promise`\<`void`\>*/} + +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. + + +CustomOptions}> +[`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CustomOptions) + +Optional custom options to include with the request. + + + +- Returns `Promise`\<`void`\> + +```typescript Example +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#cancel) + + + + +{/*> **confirm**(`payload?`): `Promise`\<`void`\>*/} + +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. + + +CustomOptions}> +[`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CustomOptions) + +Optional custom options to include with the request. + + + +- Returns `Promise`\<`void`\> + +```typescript Example +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#confirm) + + + +Error[]}> +{/*> **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/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. + +- 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` + \ 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..257760e10 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/EmailIdentifierChallenge.mdx @@ -0,0 +1,277 @@ +--- +title: "EmailIdentifierChallenge" +--- + +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) + + + +```ts Example +import EmailIdentifierChallenge from '@auth0/auth0-acul-js/email-identifier-challenge'; +const emailIdentifierChallenge = new EmailIdentifierChallenge(); +emailIdentifierChallenge.submitEmailChallenge({ + code: "" +}); +``` + + +- Extends `BaseContext` + +- Implements [`EmailIdentifierChallengeMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/EmailIdentifierChallengeMembers) + +## Constructors + + +{/*> **new EmailIdentifierChallenge**(): `EmailIdentifierChallenge`*/} + +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 `EmailIdentifierChallenge` + +- Overrides `BaseContext.constructor` + + +## Properties + +BrandingMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#branding) + +- Inherited from `BaseContext.branding` + + + +ClientMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#client) + +- Inherited from `BaseContext.client` + + + +OrganizationMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#organization) + +- Inherited from `BaseContext.organization` + + + +PromptMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#prompt) + +- Inherited from `BaseContext.prompt` + + + +ScreenMembersOnEmailIdentifierChallenge}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#screen) + +- Overrides `BaseContext.screen` + + + +TenantMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#tenant) + +- Inherited from `BaseContext.tenant` + + + +TransactionMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#transaction) + +- Inherited from `BaseContext.transaction` + + + +UntrustedDataMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#untrusteddata) + +- Inherited from `BaseContext.untrustedData` + + + +UserMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#user) + +- Inherited from `BaseContext.user` + + + + +{/*> `static` **screenIdentifier**: `string` = `ScreenIds.EMAIL_IDENTIFIER_CHALLENGE`*/} + +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 `BaseContext.screenIdentifier` + + +## Methods + +Error[]}> +{/*> **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/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. + +- 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` + + + + +{/*> **resendCode**(`payload?`): `Promise`\<`void`\>*/} + +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) + + +CustomOptions}> +[`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CustomOptions) + + + +- Returns `Promise`\<`void`\> + +```ts Example +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#resendcode) + + + +ResendControl}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/screens/email-identifier-challenge/index.ts#L104) + +**`Utility Feature`** + +Gets resend functionality with timeout management for this screen + + +StartResendOptions}> +[`StartResendOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/StartResendOptions) + +Configuration options for resend functionality + + + +- Returns [`ResendControl`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResendControl) + +ResendControl object with startResend method + +```ts 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(); +``` + +- 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#resendmanager) + + + + +{/*> **returnToPrevious**(`payload?`): `Promise`\<`void`\>*/} + +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) + + +CustomOptions}> +[`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CustomOptions) + + + +- Returns `Promise`\<`void`\> + +```ts Example +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#returntoprevious) + + + + +{/*> **submitEmailChallenge**(`payload`): `Promise`\<`void`\>*/} + +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) + + +EmailChallengeOptions}> +[`EmailChallengeOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/EmailChallengeOptions) + + + +- Returns `Promise`\<`void`\> + +```ts Example +import EmailIdentifierChallenge from '@auth0/auth0-acul-js/email-identifier-challenge'; + +const emailIdentifierChallenge = new EmailIdentifierChallenge(); +emailIdentifierChallenge.submitEmailChallenge({ + code: "" +}); +``` + +- 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#submitemailchallenge) + \ 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..57e875d7f --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/EmailOTPChallenge.mdx @@ -0,0 +1,261 @@ +--- +title: "EmailOTPChallenge" +--- + +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. + + + +```ts Example +import EmailOTPChallenge from '@auth0/auth0-acul-js/email-otp-challenge'; + +const emailOTPChallenge = new EmailOTPChallenge(); +emailOTPChallenge.submitCode({ + code: '123456', +}); +``` + + +- Extends `BaseContext` + +- Implements [`EmailOTPChallengeMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/EmailOTPChallengeMembers) + +## Constructors + + +{/*> **new EmailOTPChallenge**(): `EmailOTPChallenge`*/} + +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 `EmailOTPChallenge` + +- Overrides `BaseContext.constructor` + + +## Properties + +BrandingMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#branding) + +- Inherited from `BaseContext.branding` + + + +ClientMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#client) + +- Inherited from `BaseContext.client` + + + +OrganizationMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#organization) + +- Inherited from `BaseContext.organization` + + + +PromptMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#prompt) + +- Inherited from `BaseContext.prompt` + + + +ScreenMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#screen) + +- Inherited from `BaseContext.screen` + + + +TenantMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#tenant) + +- Inherited from `BaseContext.tenant` + + + +TransactionMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#transaction) + +- Inherited from `BaseContext.transaction` + + + +UntrustedDataMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#untrusteddata) + +- Inherited from `BaseContext.untrustedData` + + + +UserMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#user) + +- Inherited from `BaseContext.user` + + + + +{/*> `static` **screenIdentifier**: `string` = `ScreenIds.EMAIL_OTP_CHALLENGE`*/} + +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 `BaseContext.screenIdentifier` + + +## Methods + +Error[]}> +{/*> **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/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. + +- 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` + + + + +{/*> **resendCode**(`options?`): `Promise`\<`void`\>*/} + +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. + + +CustomOptions}> +[`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CustomOptions) + +Optional parameters to include in the resend request. + + + +- Returns `Promise`\<`void`\> + +```typescript Example +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#resendcode) + + + +ResendControl}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/screens/email-otp-challenge/index.ts#L100) + +**`Utility Feature`** + +Gets resend functionality with timeout management for this screen + + +StartResendOptions}> +[`StartResendOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/StartResendOptions) + +Configuration options for resend functionality + + + +- Returns [`ResendControl`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResendControl) + +ResendControl object with startResend method + +```typescript Example +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#resendmanager) + + + + +{/*> **submitCode**(`options`): `Promise`\<`void`\>*/} + +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. + + +OtpCodeOptions}> +[`OtpCodeOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OtpCodeOptions) + +Optional parameters to include in the submission. + + + +- Returns `Promise`\<`void`\> + +```typescript Example +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#submitcode) + \ 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..15eab9e92 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/EmailVerificationResult.mdx @@ -0,0 +1,178 @@ +--- +title: "EmailVerificationResult" +--- + +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 + + + +```typescript Example +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., Go to Login +} +``` + + +- Extends `BaseContext` + +- Implements [`EmailVerificationResultMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/EmailVerificationResultMembers) + +## Constructors + + +{/*> **new EmailVerificationResult**(): `EmailVerificationResult`*/} + +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 + +- 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` + + +## Properties + +BrandingMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#branding) + +- Inherited from `BaseContext.branding` + + + +ClientMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#client) + +- Inherited from `BaseContext.client` + + + +OrganizationMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#organization) + +- Inherited from `BaseContext.organization` + + + +PromptMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#prompt) + +- Inherited from `BaseContext.prompt` + + + +ScreenMembersOnEmailVerificationResult}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#screen) + +- Overrides `BaseContext.screen` + + + +TenantMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#tenant) + +- Inherited from `BaseContext.tenant` + + + +TransactionMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#transaction) + +- Inherited from `BaseContext.transaction` + + + +UntrustedDataMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#untrusteddata) + +- Inherited from `BaseContext.untrustedData` + + + +UserMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#user) + +- Inherited from `BaseContext.user` + + + + +{/*> `static` **screenIdentifier**: `string` = `ScreenIds.EMAIL_VERIFICATION_RESULT`*/} + +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 + +- Overrides `BaseContext.screenIdentifier` + + +## Methods + +Error[]}> +{/*> **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/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. + +- 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` + \ 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..b9b4a9ef3 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/InterstitialCaptcha.mdx @@ -0,0 +1,187 @@ +--- +title: "InterstitialCaptcha" +--- + +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) + + + +```ts Example +import InterstitialCaptcha from "@auth0/auth0-acul-js/interstitial-captcha"; +const interstitialCaptcha = new InterstitialCaptcha(); +interstitialCaptcha.submitCaptcha({ + captcha: "captchaValue", +}); +``` + + +- Extends `BaseContext` + +- Implements [`InterstitialCaptchaMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/InterstitialCaptchaMembers) + +## Constructors + + +{/*> **new InterstitialCaptcha**(): `InterstitialCaptcha`*/} + +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 `InterstitialCaptcha` + +- Overrides `BaseContext.constructor` + + +## Properties + +BrandingMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#branding) + +- Inherited from `BaseContext.branding` + + + +ClientMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#client) + +- Inherited from `BaseContext.client` + + + +OrganizationMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#organization) + +- Inherited from `BaseContext.organization` + + + +PromptMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#prompt) + +- Inherited from `BaseContext.prompt` + + + +ScreenMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#screen) + +- Inherited from `BaseContext.screen` + + + +TenantMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#tenant) + +- Inherited from `BaseContext.tenant` + + + +TransactionMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#transaction) + +- Inherited from `BaseContext.transaction` + + + +UntrustedDataMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#untrusteddata) + +- Inherited from `BaseContext.untrustedData` + + + +UserMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#user) + +- Inherited from `BaseContext.user` + + + + +{/*> `static` **screenIdentifier**: `string` = `ScreenIds.INTERSTITIAL_CAPTCHA`*/} + +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 `BaseContext.screenIdentifier` + + +## Methods + +Error[]}> +{/*> **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/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. + +- 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` + + + + +{/*> **submitCaptcha**(`payload`): `Promise`\<`void`\>*/} + +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) + + +SubmitCaptchaOptions}> +[`SubmitCaptchaOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/SubmitCaptchaOptions) + + + +- Returns `Promise`\<`void`\> + +#### Remarks + +This methods handles InterstitialCaptcha related configuration. + +```ts Example +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#submitcaptcha) + \ 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..f4ae97672 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/Login.mdx @@ -0,0 +1,271 @@ +--- +title: "Login" +--- + +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 + + + +```ts Example +import Login from "@auth0/auth0-acul-js/login"; +const loginManager = new Login(); +loginManager.login({ + username: "testUser", + password: "testPassword" +}); +``` + + +- Extends `BaseContext` + +- Implements [`LoginMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/LoginMembers) + +## Constructors + + +{/*> **new Login**(): `Login`*/} + +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 + +- Returns `Login` + +- Overrides `BaseContext.constructor` + + +## Properties + +BrandingMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#branding) + +- Inherited from `BaseContext.branding` + + + +ClientMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#client) + +- Inherited from `BaseContext.client` + + + +OrganizationMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#organization) + +- Inherited from `BaseContext.organization` + + + +PromptMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#prompt) + +- Inherited from `BaseContext.prompt` + + + +ScreenMembersOnLogin}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#screen) + +- Overrides `BaseContext.screen` + + + +TenantMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#tenant) + +- Inherited from `BaseContext.tenant` + + + +TransactionMembersOnLogin}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#transaction) + +- Overrides `BaseContext.transaction` + + + +UntrustedDataMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#untrusteddata) + +- Inherited from `BaseContext.untrustedData` + + + +UserMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#user) + +- Inherited from `BaseContext.user` + + + + +{/*> `static` **screenIdentifier**: `string` = `ScreenIds.LOGIN`*/} + +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 `BaseContext.screenIdentifier` + + +## Methods + + +{/*> **federatedLogin**(`payload`): `Promise`\<`void`\>*/} + +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 + + +FederatedLoginPayloadOptions}> +[`FederatedLoginPayloadOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/FederatedLoginPayloadOptions) + +The social login options containing connection name + + + +- Returns `Promise`\<`void`\> + +```typescript Example +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#federatedlogin) + + + +Error[]}> +{/*> **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/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. + +- 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` + + + +ScreenIdentifierType[]}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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 + +```typescript Example +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#getloginidentifiers) + + + + +{/*> **login**(`payload`): `Promise`\<`void`\>*/} + +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 + + +LoginPayloadOptions}> +[`LoginPayloadOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/LoginPayloadOptions) + +The login options containing username and password + + + +- Returns `Promise`\<`void`\> + +```typescript Example +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#login) + + + + +{/*> **pickCountryCode**(`payload?`): `Promise`\<`void`\>*/} + +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 + + +CustomOptions}> +[`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CustomOptions) + +Optional custom options + + + +- Returns `Promise`\<`void`\> + +```typescript Example +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#pickcountrycode) + \ 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..3931dcdd8 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/LoginEmailVerification.mdx @@ -0,0 +1,356 @@ +--- +title: "LoginEmailVerification" +--- + +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. +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. + + + +```typescript Example +// 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 + + +{/*> **new LoginEmailVerification**(): `LoginEmailVerification`*/} + +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 + +- Returns `LoginEmailVerification` + +- Overrides `BaseContext.constructor` + + +## Properties + +BrandingMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#branding) + +- Inherited from `BaseContext.branding` + + + +ClientMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#client) + +- Inherited from `BaseContext.client` + + + +OrganizationMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#organization) + +- Inherited from `BaseContext.organization` + + + +PromptMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#prompt) + +- Inherited from `BaseContext.prompt` + + + +ScreenMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#screen) + +- Inherited from `BaseContext.screen` + + + +TenantMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#tenant) + +- Inherited from `BaseContext.tenant` + + + +TransactionMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#transaction) + +- Inherited from `BaseContext.transaction` + + + +UntrustedDataMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#untrusteddata) + +- Inherited from `BaseContext.untrustedData` + + + +UserMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#user) + +- Inherited from `BaseContext.user` + + + + +{/*> `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/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 +class is instantiated in the correct screen context. + +- Overrides `BaseContext.screenIdentifier` + + +## Methods + + +{/*> **continueWithCode**(`payload`): `Promise`\<`void`\>*/} + +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 +and the required `action: "default"`, to the `/u/login-email-verification` endpoint. + + +ContinueWithCodeOptionPayload}> +[`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. + + + +- 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. + +```typescript Example +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#continuewithcode) + + + +Error[]}> +{/*> **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/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. + +- 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` + + + + +{/*> **resendCode**(`payload?`): `Promise`\<`void`\>*/} + +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. +This method posts form data with `action: "resend-code"` to the +`/u/login-email-verification` endpoint. + + +ResendCodeOptionsPayload}> +[`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. + + + +- 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`. + +```typescript Example +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#resendcode) + + + +ResendControl}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/screens/login-email-verification/index.ts#L222) + +**`Utility Feature`** + +Gets resend functionality with timeout management for this screen + + +StartResendOptions}> +[`StartResendOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/StartResendOptions) + +Configuration options for resend functionality + + + +- Returns [`ResendControl`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResendControl) + +ResendControl object with startResend method + +```typescript Example +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#resendmanager) + \ 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..23bd4b2b7 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/LoginId.mdx @@ -0,0 +1,369 @@ +--- +title: "LoginId" +--- + +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) + + + +```ts Example +import LoginId from "@auth0/auth0-acul-js/login"; +const loginIdManager = new LoginId(); +loginIdManager.getLoginIdentifiers(); +``` + + +- Extends `BaseContext` +- Implements [`LoginIdMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/LoginIdMembers) + +## Constructors + + +{/*> **new LoginId**(): `LoginId`*/} + +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. + +- Returns `LoginId` + +- Overrides `BaseContext.constructor` + + +## Properties + +BrandingMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#branding) + +- Inherited from `BaseContext.branding` + + + +ClientMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#client) + +- Inherited from `BaseContext.client` + + + +OrganizationMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#organization) + +- Inherited from `BaseContext.organization` + + + +PromptMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#prompt) + +- Inherited from `BaseContext.prompt` + + + +ScreenMembersOnLoginId}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#screen) + +- Overrides `BaseContext.screen` + + + +TenantMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#tenant) + +- Inherited from `BaseContext.tenant` + + + +TransactionMembersOnLoginId}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#transaction) + +- Overrides `BaseContext.transaction` + + + +UntrustedDataMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#untrusteddata) + +- Inherited from `BaseContext.untrustedData` + + + +UserMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#user) + +- Inherited from `BaseContext.user` + + + + +{/*> `static` **screenIdentifier**: `string` = `ScreenIds.LOGIN_ID`*/} + +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 `BaseContext.screenIdentifier` + + +## Methods + + +{/*> **federatedLogin**(`payload`): `Promise`\<`void`\>*/} + +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) + + +FederatedLoginOptions}> +[`FederatedLoginOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/FederatedLoginOptions) + + + +- Returns `Promise`\<`void`\> +- 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#federatedlogin) + +```ts 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, +}); +``` + + + + +Error[]}> +{/*> **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/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. + +- 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` + + + +ScreenIdentifierType[]}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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 + + +```typescript Example +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#getloginidentifiers) + + + + +{/*> **login**(`payload`): `Promise`\<`void`\>*/} + +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) + + +LoginOptions}> +[`LoginOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/LoginOptions) + + + +- Returns `Promise`\<`void`\> + + +```ts Example +import LoginId from "@auth0/auth0-acul-js/login-id"; + +const loginIdManager = new LoginId(); + +loginIdManager.login({ + username: +}); +``` + +- 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#login) + + + + +{/*> **passkeyLogin**(`payload?`): `Promise`\<`void`\>*/} + +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) + + +CustomOptions}> +[`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CustomOptions) + + + +- Returns `Promise`\<`void`\> + + +```ts 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(); +``` + +- 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#passkeylogin) + + + + +{/*> **pickCountryCode**(`payload?`): `Promise`\<`void`\>*/} + +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) + + +CustomOptions}> +[`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CustomOptions) + + + +- Returns `Promise`\<`void`\> + + +```ts Example +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#pickcountrycode) + + +### Passkeys + +{/*> **registerPasskeyAutofill**(`inputId?`): `Promise`\<`void`\>*/} + +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`** + +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 ``. +- 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 + +``` + +--- +### 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. + +#### Parameters + + +`string` + +Optional ID of the username `` element (without `#`). Example: `"username"`. +If omitted, the developer must manually ensure the correct `autocomplete` attributes. + + +- Returns `Promise`\<`void`\> + +```ts Example +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: + // + // 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. \ 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..1ff82a0e0 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/LoginPassword.mdx @@ -0,0 +1,227 @@ +--- +title: "LoginPassword" +--- + +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) + + + +```ts Example +import LoginPassword from "@auth0/auth0-acul-js/login-password"; +const loginPasswordManager = new LoginPassword(); +loginPasswordManager.login({ + username: "testUser", + password: "******" +}); +``` + + +- Extends `BaseContext` + +- Implements [`LoginPasswordMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/LoginPasswordMembers) + +## Constructors + + +{/*> **new LoginPassword**(): `LoginPassword`*/} + +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 `LoginPassword` + +- Overrides `BaseContext.constructor` + + +## Properties + +BrandingMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#branding) + +- Inherited from `BaseContext.branding` + + + +ClientMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#client) + +- Inherited from `BaseContext.client` + + + +OrganizationMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#organization) + +- Inherited from `BaseContext.organization` + + + +PromptMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#prompt) + +- Inherited from `BaseContext.prompt` + + + +ScreenMembersOnLoginPassword}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#screen) + +- Overrides `BaseContext.screen` + + + +TenantMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#tenant) + +- Inherited from `BaseContext.tenant` + + + +TransactionMembersOnLoginPassword}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#transaction) + +- Overrides `BaseContext.transaction` + + + +UntrustedDataMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#untrusteddata) + +- Inherited from `BaseContext.untrustedData` + + + +UserMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#user) + +- Inherited from `BaseContext.user` + + + + +{/*> `static` **screenIdentifier**: `string` = `ScreenIds.LOGIN_PASSWORD`*/} + +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 `BaseContext.screenIdentifier` + + +## Methods + + +{/*> **federatedLogin**(`payload`): `Promise`\<`void`\>*/} + +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) + + +FederatedLoginPasswordOptions}> +[`FederatedLoginPasswordOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/FederatedLoginPasswordOptions) + + + +- Returns `Promise`\<`void`\> + +```ts 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, +}); +``` + +- 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#federatedlogin) + + + +Error[]}> +{/*> **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/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. + +- 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` + + + + +{/*> **login**(`payload`): `Promise`\<`void`\>*/} + +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) + + +LoginPasswordOptions}> +[`LoginPasswordOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/LoginPasswordOptions) + + + +- Returns `Promise`\<`void`\> + +#### Remarks + +This methods handles login-password related configuration. + +```ts Example +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#login) + \ 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..d7ace9782 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/LoginPasswordlessEmailCode.mdx @@ -0,0 +1,263 @@ +--- +title: "LoginPasswordlessEmailCode" +--- + +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) + + + +```ts Example +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(); +``` + + +- Extends `BaseContext` + +- Implements [`LoginPasswordlessEmailCodeMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/LoginPasswordlessEmailCodeMembers) + +## Constructors + + +{/*> **new LoginPasswordlessEmailCode**(): `LoginPasswordlessEmailCode`*/} + +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 `LoginPasswordlessEmailCode` + +- Overrides `BaseContext.constructor` + + +## Properties + +BrandingMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#branding) + +- Inherited from `BaseContext.branding` + + + +ClientMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#client) + +- Inherited from `BaseContext.client` + + + +OrganizationMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#organization) + +- Inherited from `BaseContext.organization` + + + +PromptMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#prompt) + +- Inherited from `BaseContext.prompt` + + + +ScreenMembersOnLoginPasswordlessEmailCode}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#screen) + +- Overrides `BaseContext.screen` + + + +TenantMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#tenant) + +- Inherited from `BaseContext.tenant` + + + +TransactionMembersOnLoginPasswordlessEmailCode}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#transaction) + +- Overrides `BaseContext.transaction` + + + +UntrustedDataMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#untrusteddata) + +- Inherited from `BaseContext.untrustedData` + + + +UserMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#user) + +- Inherited from `BaseContext.user` + + + + +{/*> `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/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/screens/login-passwordless-email-code/index.ts#L22) + +- Overrides `BaseContext.screenIdentifier` + + +## Methods + +Error[]}> +{/*> **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/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. + +- 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` + + + + +{/*> **resendCode**(`payload?`): `Promise`\<`void`\>*/} + +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) + + +CustomOptions}> +[`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CustomOptions) + + + +- Returns `Promise`\<`void`\> + +```ts Example +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#resendcode) + + + +ResendControl}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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. + + +StartResendOptions}> +[`StartResendOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/StartResendOptions) + +Configuration options for the resend control + + + +- Returns [`ResendControl`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResendControl) + +A ResendControl object with resend functionality and state management + +```typescript Example +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#resendmanager) + + + + +{/*> **submitCode**(`payload`): `Promise`\<`void`\>*/} + +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) + + +SubmitCodeOptions}> +[`SubmitCodeOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/SubmitCodeOptions) + + + +- Returns `Promise`\<`void`\> + +```ts 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: ""; +}); +``` + +- 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#submitcode) + \ 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..922ac639f --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/LoginPasswordlessSmsOtp.mdx @@ -0,0 +1,261 @@ +--- +title: "LoginPasswordlessSmsOtp" +--- + +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) + + + +```ts Example +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(); +``` + + +- Extends `BaseContext` + +- Implements [`LoginPasswordlessSmsOtpMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/LoginPasswordlessSmsOtpMembers) + +## Constructors + + +{/*> **new LoginPasswordlessSmsOtp**(): `LoginPasswordlessSmsOtp`*/} + +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 `LoginPasswordlessSmsOtp` + +- Overrides `BaseContext.constructor` + + +## Properties + +BrandingMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#branding) + +- Inherited from `BaseContext.branding` + + + +ClientMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#client) + +- Inherited from `BaseContext.client` + + + +OrganizationMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#organization) + +- Inherited from `BaseContext.organization` + + + +PromptMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#prompt) + +- Inherited from `BaseContext.prompt` + + + +ScreenMembersOnLoginPasswordlessSmsOtp}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#screen) + +- Overrides `BaseContext.screen` + + + +TenantMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#tenant) + +- Inherited from `BaseContext.tenant` + + + +TransactionMembersOnLoginPasswordlessSmsOtp}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#transaction) + +- Overrides `BaseContext.transaction` + + + +UntrustedDataMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#untrusteddata) + +- Inherited from `BaseContext.untrustedData` + + + +UserMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#user) + +- Inherited from `BaseContext.user` + + + + +{/*> `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/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/screens/login-passwordless-sms-otp/index.ts#L22) + +- Overrides `BaseContext.screenIdentifier` + + +## Methods + +Error[]}> +{/*> **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/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. + +- 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` + + + +ResendControl}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/screens/login-passwordless-sms-otp/index.ts#L98) + +**`Utility Feature`** + +Gets resend functionality with timeout management for this screen + + +StartResendOptions}> +[`StartResendOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/StartResendOptions) + +Configuration options for resend functionality + + + +- Returns [`ResendControl`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResendControl) + +ResendControl object with startResend method + +```typescript Example +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#resendmanager) + + + + +{/*> **resendOTP**(`payload?`): `Promise`\<`void`\>*/} + +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) + + +CustomOptions}> +[`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CustomOptions) + + + +- Returns `Promise`\<`void`\> + +```ts Example +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#resendotp) + + + + +{/*> **submitOTP**(`payload`): `Promise`\<`void`\>*/} + +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) + + +SubmitOTPOptions}> +[`SubmitOTPOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/SubmitOTPOptions) + + + +- Returns `Promise`\<`void`\> + +```ts Example +import LoginPasswordlessSmsOtp from '@auth0/auth0-acul-js/login-passwordless-sms-otp'; +const loginPasswordlessSmsOtp = new LoginPasswordlessSmsOtp(); + +loginPasswordlessSmsOtp.submitOTP({ + username: "test@domain.com"; + code: ""; +}); +``` + +- 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#submitotp) + \ 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..5dce6238a --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/Logout.mdx @@ -0,0 +1,191 @@ +--- +title: "Logout" +--- + +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. + + + +```ts Example +import Logout from '@auth0/auth0-acul-js/logout'; + +const logout = new Logout(); + +await logout.confirmLogout({ action: 'accept' }); +``` + + +- Extends `BaseContext` + +- Implements [`LogoutMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/LogoutMembers) + +## Constructors + + +{/*> **new Logout**(): `Logout`*/} + +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. + +- Returns `Logout` + +- Overrides `BaseContext.constructor` + + +## Properties + +BrandingMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#branding) + +- Inherited from `BaseContext.branding` + + + +ClientMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#client) + +- Inherited from `BaseContext.client` + + + +OrganizationMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#organization) + +- Inherited from `BaseContext.organization` + + + +PromptMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#prompt) + +- Inherited from `BaseContext.prompt` + + + +ScreenMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#screen) + +- Inherited from `BaseContext.screen` + + + +TenantMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#tenant) + +- Inherited from `BaseContext.tenant` + + + +TransactionMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#transaction) + +- Inherited from `BaseContext.transaction` + + + +UntrustedDataMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#untrusteddata) + +- Inherited from `BaseContext.untrustedData` + + + +UserMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#user) + +- Inherited from `BaseContext.user` + + + + +{/*> `static` **screenIdentifier**: `string` = `ScreenIds.LOGOUT`*/} + +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 `BaseContext.screenIdentifier` + + +## Methods + + +{/*> **confirmLogout**(`payload`): `Promise`\<`void`\>*/} + +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). + + +ConfirmLogoutOptions}> +[`ConfirmLogoutOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ConfirmLogoutOptions) + +The options containing the action to perform. + + + +- Returns `Promise`\<`void`\> + +```typescript Example +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#confirmlogout) + + + +Error[]}> +{/*> **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/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. + +- 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` + \ 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..140653ade --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/LogoutAborted.mdx @@ -0,0 +1,152 @@ +--- +title: "LogoutAborted" +--- + +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. + + +- Extends `BaseContext` + +- Implements [`LogoutAbortedMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/LogoutAbortedMembers) + +## Constructors + + +{/*> **new LogoutAborted**(): `LogoutAborted`*/} + +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 + +- Returns `LogoutAborted` + +- Overrides `BaseContext.constructor` + + +## Properties + +BrandingMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#branding) + +- Inherited from `BaseContext.branding` + + + +ClientMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#client) + +- Inherited from `BaseContext.client` + + + +OrganizationMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#organization) + +- Inherited from `BaseContext.organization` + + + +PromptMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#prompt) + +- Inherited from `BaseContext.prompt` + + + +ScreenMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#screen) + +- Inherited from `BaseContext.screen` + + + +TenantMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#tenant) + +- Inherited from `BaseContext.tenant` + + + +TransactionMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#transaction) + +- Inherited from `BaseContext.transaction` + + + +UntrustedDataMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#untrusteddata) + +- Inherited from `BaseContext.untrustedData` + + + +UserMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#user) + +- Inherited from `BaseContext.user` + + + + +{/*> `static` **screenIdentifier**: `string` = `ScreenIds.LOGOUT_ABORTED`*/} + +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 `BaseContext.screenIdentifier` + + +## Methods + +Error[]}> +{/*> **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/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. + +- 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` + \ 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..fd6baea35 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/LogoutComplete.mdx @@ -0,0 +1,152 @@ +--- +title: "LogoutComplete" +--- + +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. + + +- Extends `BaseContext` + +- Implements [`LogoutCompleteMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/LogoutCompleteMembers) + +## Constructors + + +{/*> **new LogoutComplete**(): `LogoutComplete`*/} + +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 + +- Returns `LogoutComplete` + +- Overrides `BaseContext.constructor` + + +## Properties + +BrandingMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#branding) + +- Inherited from `BaseContext.branding` + + + +ClientMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#client) + +- Inherited from `BaseContext.client` + + + +OrganizationMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#organization) + +- Inherited from `BaseContext.organization` + + + +PromptMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#prompt) + +- Inherited from `BaseContext.prompt` + + + +ScreenMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#screen) + +- Inherited from `BaseContext.screen` + + + +TenantMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#tenant) + +- Inherited from `BaseContext.tenant` + + + +TransactionMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#transaction) + +- Inherited from `BaseContext.transaction` + + + +UntrustedDataMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#untrusteddata) + +- Inherited from `BaseContext.untrustedData` + + + +UserMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#user) + +- Inherited from `BaseContext.user` + + + + +{/*> `static` **screenIdentifier**: `string` = `ScreenIds.LOGOUT_COMPLETE`*/} + +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 `BaseContext.screenIdentifier` + + +## Methods + +Error[]}> +{/*> **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/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. + +- 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` + \ 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..163f47ac1 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/MfaBeginEnrollOptions.mdx @@ -0,0 +1,189 @@ +--- +title: "MfaBeginEnrollOptions" +--- + +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 + + + +```ts Example +const mfaBeginEnrollOptions = new MfaBeginEnrollOptions(); +await mfaBeginEnrollOptions.enroll({ + action: 'push-notification' +}); +``` + + +- Extends `BaseContext` + +- Implements [`MfaBeginEnrollOptionsMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaBeginEnrollOptionsMembers) + +## Constructors + + +{/*> **new MfaBeginEnrollOptions**(): `MfaBeginEnrollOptions`*/} + +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 + +- Returns `MfaBeginEnrollOptions` + +- Overrides `BaseContext.constructor` + + +## Properties + +BrandingMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#branding) + +- Inherited from `BaseContext.branding` + + + +ClientMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#client) + +- Inherited from `BaseContext.client` + + + +OrganizationMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#organization) + +- Inherited from `BaseContext.organization` + + + +PromptMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#prompt) + +- Inherited from `BaseContext.prompt` + + + +ScreenMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#screen) + +- Inherited from `BaseContext.screen` + + + +TenantMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#tenant) + +- Inherited from `BaseContext.tenant` + + + +TransactionMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#transaction) + +- Inherited from `BaseContext.transaction` + + + +UntrustedDataMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#untrusteddata) + +- Inherited from `BaseContext.untrustedData` + + + +UserMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#user) + +- Inherited from `BaseContext.user` + + + + +{/*> `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/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/screens/mfa-begin-enroll-options/index.ts#L13) + +- Overrides `BaseContext.screenIdentifier` + + +## Methods + + +{/*> **enroll**(`payload`): `Promise`\<`void`\>*/} + +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 + + +MfaEnrollOptions}> +[`MfaEnrollOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaEnrollOptions) + +The enrollment options including the selected factor + + + +- Returns `Promise`\<`void`\> + +```typescript Example +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#enroll) + + + +Error[]}> +{/*> **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/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. + +- 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` + \ 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..233e67f3c --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/MfaCountryCodes.mdx @@ -0,0 +1,235 @@ +--- +title: "MfaCountryCodes" +--- + +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 + + + +```ts Example +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', +}); +``` + + +- Extends `BaseContext` + +- Implements [`MfaCountryCodesMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaCountryCodesMembers) + +## Constructors + + +{/*> **new MfaCountryCodes**(): `MfaCountryCodes`*/} + +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 + +- Returns `MfaCountryCodes` + +- Overrides `BaseContext.constructor` + + +## Properties + +BrandingMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#branding) + +- Inherited from `BaseContext.branding` + + + +ClientMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#client) + +- Inherited from `BaseContext.client` + + + +OrganizationMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#organization) + +- Inherited from `BaseContext.organization` + + + +PromptMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#prompt) + +- Inherited from `BaseContext.prompt` + + + +ScreenMembersOnMfaCountryCodes}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#screen) + +- Overrides `BaseContext.screen` + + + +TenantMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#tenant) + +- Inherited from `BaseContext.tenant` + + + +TransactionMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#transaction) + +- Inherited from `BaseContext.transaction` + + + +UntrustedDataMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#untrusteddata) + +- Inherited from `BaseContext.untrustedData` + + + +UserMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#user) + +- Inherited from `BaseContext.user` + + + + +{/*> `static` **screenIdentifier**: `string` = `ScreenIds.MFA_COUNTRY_CODES`*/} + +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 `BaseContext.screenIdentifier` + + +## Methods + +Error[]}> +{/*> **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/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. + +- 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` + + + + +{/*> **goBack**(`payload?`): `Promise`\<`void`\>*/} + +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 + + +CustomOptions}> +[`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CustomOptions) + +Optional custom options to include with the request + + + +- Returns `Promise`\<`void`\> + +```typescript Example +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#goback) + + + + +{/*> **selectCountryCode**(`payload`): `Promise`\<`void`\>*/} + +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 + + +SelectCountryCodeOptions}> +[`SelectCountryCodeOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/SelectCountryCodeOptions) + +The options containing the country code selection action + + + +- Returns `Promise`\<`void`\> + +```typescript Example +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#selectcountrycode) + \ 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..15de0d31f --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/MfaDetectBrowserCapabilities.mdx @@ -0,0 +1,185 @@ +--- +title: "MfaDetectBrowserCapabilities" +--- + +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 + + + +```ts Example +const mfaDetectBrowserCapabilities = new MfaDetectBrowserCapabilities(); +await mfaDetectBrowserCapabilities.detectCapabilities(); +``` + + +- Extends `BaseContext` + +- Implements [`MfaDetectBrowserCapabilitiesMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaDetectBrowserCapabilitiesMembers) + +## Constructors + + +{/*> **new MfaDetectBrowserCapabilities**(): `MfaDetectBrowserCapabilities`*/} + +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 + +- Returns `MfaDetectBrowserCapabilities` + +- Overrides `BaseContext.constructor` + + +## Properties + +BrandingMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#branding) + +- Inherited from `BaseContext.branding` + + + +ClientMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#client) + +- Inherited from `BaseContext.client` + + + +OrganizationMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#organization) + +- Inherited from `BaseContext.organization` + + + +PromptMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#prompt) + +- Inherited from `BaseContext.prompt` + + + +ScreenMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#screen) + +- Inherited from `BaseContext.screen` + + + +TenantMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#tenant) + +- Inherited from `BaseContext.tenant` + + + +TransactionMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#transaction) + +- Inherited from `BaseContext.transaction` + + + +UntrustedDataMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#untrusteddata) + +- Inherited from `BaseContext.untrustedData` + + + +UserMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#user) + +- Inherited from `BaseContext.user` + + + + +{/*> `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/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/screens/mfa-detect-browser-capabilities/index.ts#L15) + +- Overrides `BaseContext.screenIdentifier` + + +## Methods + + +{/*> **detectCapabilities**(`payload?`): `Promise`\<`void`\>*/} + +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 + + +CustomOptions}> +[`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CustomOptions) + +The options containing browser capability flags + + + +- Returns `Promise`\<`void`\> + +```typescript Example +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#detectcapabilities) + + + +Error[]}> +{/*> **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/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. + +- 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` + \ 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..64017d5c9 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/MfaEmailChallenge.mdx @@ -0,0 +1,322 @@ +--- +title: "MfaEmailChallenge" +--- + +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 + + + +```ts Example +import MfaEmailChallenge from '@auth0/auth0-acul-js/mfa-email-challenge'; + +const mfaEmailChallenge = new MfaEmailChallenge(); +await mfaEmailChallenge.continue({ + code: '123456', + rememberDevice: true +}); +``` + + +- Extends `BaseContext` + +- Implements [`MfaEmailChallengeMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaEmailChallengeMembers) + +## Constructors + + +{/*> **new MfaEmailChallenge**(): `MfaEmailChallenge`*/} + +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 + +- Returns `MfaEmailChallenge` + +- Overrides `BaseContext.constructor` + + +## Properties + +BrandingMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#branding) + +- Inherited from `BaseContext.branding` + + + +ClientMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#client) + +- Inherited from `BaseContext.client` + + + +OrganizationMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#organization) + +- Inherited from `BaseContext.organization` + + + +PromptMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#prompt) + +- Inherited from `BaseContext.prompt` + + + +ScreenMembersOnMfaEmailChallenge}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#screen) + +- Overrides `BaseContext.screen` + + + +TenantMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#tenant) + +- Inherited from `BaseContext.tenant` + + + +TransactionMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#transaction) + +- Inherited from `BaseContext.transaction` + + + +UntrustedDataMembersOnMfaEmailChallenge}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#untrusteddata) + +- Overrides `BaseContext.untrustedData` + + + +UserMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#user) + +- Inherited from `BaseContext.user` + + + + +{/*> `static` **screenIdentifier**: `string` = `ScreenIds.MFA_EMAIL_CHALLENGE`*/} + +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 `BaseContext.screenIdentifier` + + +## Methods + + +{/*> **continue**(`payload`): `Promise`\<`void`\>*/} + +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 + + +ContinuePayloadOptions}> +[`ContinuePayloadOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ContinuePayloadOptions) + +The options containing the code and rememberDevice flag + + + +- Returns `Promise`\<`void`\> + +```typescript Example +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#continue) + + + +Error[]}> +{/*> **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/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. + +- 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` + + + + +{/*> **pickEmail**(`payload?`): `Promise`\<`void`\>*/} + +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. + + +CustomOptions}> +[`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CustomOptions) + +Optional payload. + + + +- Returns `Promise`\<`void`\> + +```typescript Example +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#pickemail) + + + + +{/*> **resendCode**(`payload?`): `Promise`\<`void`\>*/} + +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 + + +ResendCodePayloadOptions}> +[`ResendCodePayloadOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResendCodePayloadOptions) + +Optional custom options to include with the request + + + +- Returns `Promise`\<`void`\> + +```typescript Example +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#resendcode) + + + +ResendControl}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/screens/mfa-email-challenge/index.ts#L162) + +**`Utility Feature`** + +Gets resend functionality with timeout management for this screen + + +StartResendOptions}> +[`StartResendOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/StartResendOptions) + +Configuration options for resend functionality + + + +- Returns [`ResendControl`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResendControl) + +ResendControl object with startResend method + +```typescript Example +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#resendmanager) + + + + +{/*> **tryAnotherMethod**(`payload?`): `Promise`\<`void`\>*/} + +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 + + +TryAnotherMethodPayloadOptions}> +[`TryAnotherMethodPayloadOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TryAnotherMethodPayloadOptions) + +Optional custom options to include with the request + + + +- Returns `Promise`\<`void`\> + +```typescript Example +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#tryanothermethod) + \ 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..7d96bb51d --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/MfaEmailList.mdx @@ -0,0 +1,223 @@ +--- +title: "MfaEmailList" +--- + +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 + + + +```ts Example +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 +}); +``` + + +- Extends `BaseContext` + +- Implements [`MfaEmailListMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaEmailListMembers) + +## Constructors + + +{/*> **new MfaEmailList**(): `MfaEmailList`*/} + +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 + +- Returns `MfaEmailList` + +- Overrides `BaseContext.constructor` + + +## Properties + +BrandingMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#branding) + +- Inherited from `BaseContext.branding` + + + +ClientMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#client) + +- Inherited from `BaseContext.client` + + + +OrganizationMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#organization) + +- Inherited from `BaseContext.organization` + + + +PromptMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#prompt) + +- Inherited from `BaseContext.prompt` + + + +ScreenMembersOnMfaEmailList}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#screen) + +- Overrides `BaseContext.screen` + + + +TenantMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#tenant) + +- Inherited from `BaseContext.tenant` + + + +TransactionMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#transaction) + +- Inherited from `BaseContext.transaction` + + + +UntrustedDataMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#untrusteddata) + +- Inherited from `BaseContext.untrustedData` + + + +UserMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#user) + +- Inherited from `BaseContext.user` + + + + +{/*> `static` **screenIdentifier**: `string` = `ScreenIds.MFA_EMAIL_LIST`*/} + +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 `BaseContext.screenIdentifier` + + +## Methods + +Error[]}> +{/*> **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/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. + +- 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` + + + + +{/*> **goBack**(`payload?`): `Promise`\<`void`\>*/} + +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 + + +CustomOptions}> +[`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CustomOptions) + +Optional custom options to include with the request + + + +- Returns `Promise`\<`void`\> + +```typescript Example +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#goback) + + + + +{/*> **selectMfaEmail**(`payload`): `Promise`\<`void`\>*/} + +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 + + +SelectMfaEmailOptions}> +[`SelectMfaEmailOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/SelectMfaEmailOptions) + +The options containing the selection action + + + +- Returns `Promise`\<`void`\> + +```typescript Example +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#selectmfaemail) + \ 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..31d6c59bd --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/MfaEnrollResult.mdx @@ -0,0 +1,175 @@ +--- +title: "MfaEnrollResult" +--- + +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 + + + +```typescript Example +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 + + +{/*> **new MfaEnrollResult**(): `MfaEnrollResult`*/} + +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 +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` + + +## Properties + +BrandingMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#branding) + +- Inherited from `BaseContext.branding` + + + +ClientMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#client) + +- Inherited from `BaseContext.client` + + + +OrganizationMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#organization) + +- Inherited from `BaseContext.organization` + + + +PromptMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#prompt) + +- Inherited from `BaseContext.prompt` + + + +ScreenMembersOnMfaEnrollResult}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#screen) + +- Overrides `BaseContext.screen` + + + +TenantMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#tenant) + +- Inherited from `BaseContext.tenant` + + + +TransactionMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#transaction) + +- Inherited from `BaseContext.transaction` + + + +UntrustedDataMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#untrusteddata) + +- Inherited from `BaseContext.untrustedData` + + + +UserMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#user) + +- Inherited from `BaseContext.user` + + + + +{/*> `static` **screenIdentifier**: `string` = `ScreenIds.MFA_ENROLL_RESULT`*/} + +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 + +- Overrides `BaseContext.screenIdentifier` + + +## Methods + +Error[]}> +{/*> **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/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. + +- 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` + \ 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..1eeed18f7 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/MfaLoginOptions.mdx @@ -0,0 +1,215 @@ +--- +title: "MfaLoginOptions" +--- + +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 + + + +```ts Example +const mfaLoginOptions = new MfaLoginOptions(); +await mfaLoginOptions.enroll({ + action: 'push-notification' +}); +``` + + +- Extends `BaseContext` + +- Implements [`MfaLoginOptionsMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaLoginOptionsMembers) + +## Constructors + + +{/*> **new MfaLoginOptions**(): `MfaLoginOptions`*/} + +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 + +- Returns `MfaLoginOptions` + +- Overrides `BaseContext.constructor` + + +## Properties + +BrandingMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#branding) + +- Inherited from `BaseContext.branding` + + + +ClientMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#client) + +- Inherited from `BaseContext.client` + + + +OrganizationMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#organization) + +- Inherited from `BaseContext.organization` + + + +PromptMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#prompt) + +- Inherited from `BaseContext.prompt` + + + +ScreenMembersOnMfaLoginOptions}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#screen) + +- Overrides `BaseContext.screen` + + + +TenantMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#tenant) + +- Inherited from `BaseContext.tenant` + + + +TransactionMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#transaction) + +- Inherited from `BaseContext.transaction` + + + +UntrustedDataMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#untrusteddata) + +- Inherited from `BaseContext.untrustedData` + + + +UserMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#user) + +- Inherited from `BaseContext.user` + + + + +{/*> `static` **screenIdentifier**: `string` = `ScreenIds.MFA_LOGIN_OPTIONS`*/} + +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 `BaseContext.screenIdentifier` + + +## Methods + + +{/*> **enroll**(`payload`): `Promise`\<`void`\>*/} + +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 + + +LoginEnrollOptions}> +[`LoginEnrollOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/LoginEnrollOptions) + +The options containing the selected factor + + + +- Returns `Promise`\<`void`\> + +```typescript Example +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#enroll) + + + +Error[]}> +{/*> **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/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. + +- 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` + + + + +{/*> **returnToPrevious**(`payload?`): `Promise`\<`void`\>*/} + +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) + + +CustomOptions}> +[`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CustomOptions) + + + +- Returns `Promise`\<`void`\> + +```ts Example +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#returntoprevious) + \ 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..ccf608fb3 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/MfaOtpChallenge.mdx @@ -0,0 +1,223 @@ +--- +title: "MfaOtpChallenge" +--- + +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 + + + +```ts Example +import MfaOtpChallenge from '@auth0/auth0-acul-js/mfa-otp-challenge'; + +const mfaOtpChallenge = new MfaOtpChallenge(); +await mfaOtpChallenge.continue({ + code: '123456', + rememberDevice: true +}); +``` + + +- Extends `BaseContext` + +- Implements [`MfaOtpChallengeMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaOtpChallengeMembers) + +## Constructors + + +{/*> **new MfaOtpChallenge**(): `MfaOtpChallenge`*/} + +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 + +- Returns `MfaOtpChallenge` + +- Overrides `BaseContext.constructor` + + +## Properties + +BrandingMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#branding) + +- Inherited from `BaseContext.branding` + + + +ClientMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#client) + +- Inherited from `BaseContext.client` + + + +OrganizationMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#organization) + +- Inherited from `BaseContext.organization` + + + +PromptMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#prompt) + +- Inherited from `BaseContext.prompt` + + + +ScreenMembersOnMfaOtpChallenge}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#screen) + +- Overrides `BaseContext.screen` + + + +TenantMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#tenant) + +- Inherited from `BaseContext.tenant` + + + +TransactionMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#transaction) + +- Inherited from `BaseContext.transaction` + + + +UntrustedDataMembersOnMfaOtpChallenge}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#untrusteddata) + +- Overrides `BaseContext.untrustedData` + + + +UserMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#user) + +- Inherited from `BaseContext.user` + + + + +{/*> `static` **screenIdentifier**: `string` = `ScreenIds.MFA_OTP_CHALLENGE`*/} + +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 `BaseContext.screenIdentifier` + + +## Methods + + +{/*> **continue**(`payload`): `Promise`\<`void`\>*/} + +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 + + +ContinueOTPOptions}> +[`ContinueOTPOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ContinueOTPOptions) + +The options containing the code and rememberDevice flag + + + +- Returns `Promise`\<`void`\> + +```typescript Example +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#continue) + + + +Error[]}> +{/*> **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/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. + +- 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` + + + + +{/*> **tryAnotherMethod**(`payload?`): `Promise`\<`void`\>*/} + +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 + + +TryAnotherMethodMfaOtpChallengeOptions}> +[`TryAnotherMethodMfaOtpChallengeOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TryAnotherMethodMfaOtpChallengeOptions) + +Optional custom options to include with the request + + + +- Returns `Promise`\<`void`\> + +```typescript Example +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#tryanothermethod) + \ 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..1edb8a1b8 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/MfaOtpEnrollmentCode.mdx @@ -0,0 +1,225 @@ +--- +title: "MfaOtpEnrollmentCode" +--- + +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. + + + +```ts Example +import MfaOtpEnrollmentCode from '@auth0/auth0-acul-js/mfa-otp-enrollment-code'; + +const mfaOtpEnrollmentCode = new MfaOtpEnrollmentCode(); +await mfaOtpEnrollmentCode.continue({ + code: '123456', +}); +``` + + +- Extends `BaseContext` + +- Implements [`MfaOtpEnrollmentCodeMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaOtpEnrollmentCodeMembers) + +## Constructors + + +{/*> **new MfaOtpEnrollmentCode**(): `MfaOtpEnrollmentCode`*/} + +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. + +- Returns `MfaOtpEnrollmentCode` + +- Overrides `BaseContext.constructor` + + +## Properties + +BrandingMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#branding) + +- Inherited from `BaseContext.branding` + + + +ClientMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#client) + +- Inherited from `BaseContext.client` + + + +OrganizationMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#organization) + +- Inherited from `BaseContext.organization` + + + +PromptMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#prompt) + +- Inherited from `BaseContext.prompt` + + + +ScreenMembersOnMfaOtpEnrollmentCode}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#screen) + +- Overrides `BaseContext.screen` + + + +TenantMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#tenant) + +- Inherited from `BaseContext.tenant` + + + +TransactionMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#transaction) + +- Inherited from `BaseContext.transaction` + + + +UntrustedDataMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#untrusteddata) + +- Inherited from `BaseContext.untrustedData` + + + +UserMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#user) + +- Inherited from `BaseContext.user` + + + + +{/*> `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/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/screens/mfa-otp-enrollment-code/index.ts#L25) + +Screen identifier for validation and telemetry + +- Overrides `BaseContext.screenIdentifier` + + +## Methods + + +{/*> **continue**(`payload`): `Promise`\<`void`\>*/} + +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. + + +MfaOtpContinueOptions}> +[`MfaOtpContinueOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaOtpContinueOptions) + +The options containing the OTP code. + + + +- Returns `Promise`\<`void`\> + +```typescript Example +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#continue) + + + +Error[]}> +{/*> **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/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. + +- 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` + + + + +{/*> **tryAnotherMethod**(`payload?`): `Promise`\<`void`\>*/} + +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. + + +MfaOtpTryAnotherMethodOptions}> +[`MfaOtpTryAnotherMethodOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaOtpTryAnotherMethodOptions) + +Optional payload. + + + +- Returns `Promise`\<`void`\> + +```typescript Example +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#tryanothermethod) + \ 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..d6352b4ac --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/MfaOtpEnrollmentQr.mdx @@ -0,0 +1,248 @@ +--- +title: "MfaOtpEnrollmentQr" +--- + +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 + + + +```ts Example +import MfaOtpEnrollmentQr from '@auth0/auth0-acul-js/mfa-otp-enrollment-qr'; + +const mfaOtpEnrollmentQr = new MfaOtpEnrollmentQr(); +await mfaOtpEnrollmentQr.toggleView(); +``` + + +- Extends `BaseContext` + +- Implements [`MfaOtpEnrollmentQrMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaOtpEnrollmentQrMembers) + +## Constructors + + +{/*> **new MfaOtpEnrollmentQr**(): `MfaOtpEnrollmentQr`*/} + +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 + +- Returns `MfaOtpEnrollmentQr` + +- Overrides `BaseContext.constructor` + + +## Properties + +BrandingMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#branding) + +- Inherited from `BaseContext.branding` + + + +ClientMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#client) + +- Inherited from `BaseContext.client` + + + +OrganizationMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#organization) + +- Inherited from `BaseContext.organization` + + + +PromptMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#prompt) + +- Inherited from `BaseContext.prompt` + + + +ScreenMembersOnMfaOtpEnrollmentQr}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#screen) + +- Overrides `BaseContext.screen` + + + +TenantMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#tenant) + +- Inherited from `BaseContext.tenant` + + + +TransactionMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#transaction) + +- Inherited from `BaseContext.transaction` + + + +UntrustedDataMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#untrusteddata) + +- Inherited from `BaseContext.untrustedData` + + + +UserMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#user) + +- Inherited from `BaseContext.user` + + + + +{/*> `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/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/screens/mfa-otp-enrollment-qr/index.ts#L23) + +Screen identifier for validation and telemetry + +- Overrides `BaseContext.screenIdentifier` + + +## Methods + + +{/*> **continue**(`payload`): `Promise`\<`void`\>*/} + +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. + + +MfaOtpEnrollmentQrContinueOptions}> +[`MfaOtpEnrollmentQrContinueOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaOtpEnrollmentQrContinueOptions) + +Payload including the OTP code and optional custom options. + + + +- Returns `Promise`\<`void`\> + +```typescript Example +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#continue) + + + +Error[]}> +{/*> **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/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. + +- 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` + + + + +{/*> **toggleView**(`payload?`): `Promise`\<`void`\>*/} + +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. + + +CustomOptions}> +[`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CustomOptions) + +An object containing any custom options. + + + +- Returns `Promise`\<`void`\> + +A promise that resolves when the action is successfully submitted. + +```typescript Example +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#toggleview) + + + + +{/*> **tryAnotherMethod**(`payload?`): `Promise`\<`void`\>*/} + +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. + + +CustomOptions}> +[`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CustomOptions) + +Optional custom options to include with the request + + + +- Returns `Promise`\<`void`\> + +```typescript Example +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#tryanothermethod) + \ 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..d120f4c5e --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/MfaPhoneChallenge.mdx @@ -0,0 +1,268 @@ +--- +title: "MfaPhoneChallenge" +--- + +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 + + + +```ts Example +const mfaPhoneChallenge = new MfaPhoneChallenge(); +// Request code via SMS +await mfaPhoneChallenge.continue({ type: 'sms' }); +// Request code via Voice Call +await mfaPhoneChallenge.continue({ type: 'voice' }); +``` + + +- Extends `BaseContext` + +- Implements [`MfaPhoneChallengeMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaPhoneChallengeMembers) + +## Constructors + + +{/*> **new MfaPhoneChallenge**(): `MfaPhoneChallenge`*/} + +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`. + +- Returns `MfaPhoneChallenge` + +- Overrides `BaseContext.constructor` + + +## Properties + +BrandingMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#branding) + +- Inherited from `BaseContext.branding` + + + +ClientMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#client) + +- Inherited from `BaseContext.client` + + + +OrganizationMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#organization) + +- Inherited from `BaseContext.organization` + + + +PromptMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#prompt) + +- Inherited from `BaseContext.prompt` + + + +ScreenMembersOnMfaPhoneChallenge}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#screen) + +- Overrides `BaseContext.screen` + + + +TenantMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#tenant) + +- Inherited from `BaseContext.tenant` + + + +TransactionMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#transaction) + +- Inherited from `BaseContext.transaction` + + + +UntrustedDataMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#untrusteddata) + +- Inherited from `BaseContext.untrustedData` + + + +UserMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#user) + +- Inherited from `BaseContext.user` + + + + +{/*> `static` **screenIdentifier**: `string` = `ScreenIds.MFA_PHONE_CHALLENGE`*/} + +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. + +- Overrides `BaseContext.screenIdentifier` + + +## Methods + + +{/*> **continue**(`payload`): `Promise`\<`void`\>*/} + +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. + + +MfaPhoneChallengeContinueOptions}> +[`MfaPhoneChallengeContinueOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaPhoneChallengeContinueOptions) + +Options containing the delivery type ('sms' or 'voice'). + + + +- 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. + +```typescript Example +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#continue) + + + +Error[]}> +{/*> **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/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. + +- 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` + + + + +{/*> **pickPhone**(`payload?`): `Promise`\<`void`\>*/} + +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. + + +MfaPhoneChallengePickPhoneOptions}> +[`MfaPhoneChallengePickPhoneOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaPhoneChallengePickPhoneOptions) + +Optional custom options for the request. + + + +- Returns `Promise`\<`void`\> + +A promise that resolves upon successful submission. + +#### Throws + +Throws an error if the submission fails. + +```typescript Example +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#pickphone) + + + + +{/*> **tryAnotherMethod**(`payload?`): `Promise`\<`void`\>*/} + +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. + + +MfaPhoneChallengePickAuthenticatorOptions}> +[`MfaPhoneChallengePickAuthenticatorOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaPhoneChallengePickAuthenticatorOptions) + +Optional custom options for the request. + + + +- Returns `Promise`\<`void`\> + +A promise that resolves upon successful submission. + +#### Throws + +Throws an error if the submission fails. + +```typescript Example +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#tryanothermethod) + \ 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..18e36ada7 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/MfaPhoneEnrollment.mdx @@ -0,0 +1,288 @@ +--- +title: "MfaPhoneEnrollment" +--- + +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. + + + +```ts Example +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 { + const options = { + state: this.transaction.state, + telemetry: [MfaPhoneEnrollment.screenIdentifier, 'pickCountryCode'], + }; + await new FormHandler(options).submitData({ + ...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 +``` + + +- Extends `BaseContext` + +- Implements [`MfaPhoneEnrollmentMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaPhoneEnrollmentMembers) + +## Constructors + + +{/*> **new MfaPhoneEnrollment**(): `MfaPhoneEnrollment`*/} + +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. + +- Returns `MfaPhoneEnrollment` + +- Overrides `BaseContext.constructor` + + +## Properties + +BrandingMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#branding) + +- Inherited from `BaseContext.branding` + + + +ClientMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#client) + +- Inherited from `BaseContext.client` + + + +OrganizationMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#organization) + +- Inherited from `BaseContext.organization` + + + +PromptMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#prompt) + +- Inherited from `BaseContext.prompt` + + + +ScreenMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#screen) + +- Inherited from `BaseContext.screen` + + + +TenantMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#tenant) + +- Inherited from `BaseContext.tenant` + + + +TransactionMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#transaction) + +- Inherited from `BaseContext.transaction` + + + +UntrustedDataMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#untrusteddata) + +- Inherited from `BaseContext.untrustedData` + + + +UserMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#user) + +- Inherited from `BaseContext.user` + + + + +{/*> `static` **screenIdentifier**: `string` = `ScreenIds.MFA_PHONE_ENROLLMENT`*/} + +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 `BaseContext.screenIdentifier` + + +## Methods + + +{/*> **continueEnrollment**(`payload`): `Promise`\<`void`\>*/} + +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). + + +MfaPhoneEnrollmentContinueOptions}> +[`MfaPhoneEnrollmentContinueOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaPhoneEnrollmentContinueOptions) + +The phone number and type (SMS or voice). + + + +- Returns `Promise`\<`void`\> + +```typescript Example +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#continueenrollment) + + + +Error[]}> +{/*> **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/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. + +- 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` + + + + +{/*> **pickCountryCode**(`payload?`): `Promise`\<`void`\>*/} + +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. + + +CustomOptions}> +[`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CustomOptions) + +Optional custom options to include with the request. + + + +- Returns `Promise`\<`void`\> + +```typescript Example +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#pickcountrycode) + + + + +{/*> **tryAnotherMethod**(`payload?`): `Promise`\<`void`\>*/} + +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. + + +CustomOptions}> +[`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CustomOptions) + +Optional custom options to include with the request. + + + +- Returns `Promise`\<`void`\> + +```typescript Example +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#tryanothermethod) + \ 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..f3c5427e6 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/MfaPushChallengePush.mdx @@ -0,0 +1,321 @@ +--- +title: "MfaPushChallengePush" +--- + +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 + + + +```ts Example +const mfaPushChallengePush = new MfaPushChallengePush(); +await mfaPushChallengePush.continue(); +``` + + +- Extends `BaseContext` + +- Implements [`MfaPushChallengePushMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaPushChallengePushMembers) + +## Constructors + + +{/*> **new MfaPushChallengePush**(): `MfaPushChallengePush`*/} + +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 + +- Returns `MfaPushChallengePush` + +- Overrides `BaseContext.constructor` + + +## Properties + +BrandingMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#branding) + +- Inherited from `BaseContext.branding` + + + +ClientMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#client) + +- Inherited from `BaseContext.client` + + + +OrganizationMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#organization) + +- Inherited from `BaseContext.organization` + + + +PromptMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#prompt) + +- Inherited from `BaseContext.prompt` + + + +ScreenMembersOnMfaPushChallengePush}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#screen) + +- Overrides `BaseContext.screen` + + + +TenantMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#tenant) + +- Inherited from `BaseContext.tenant` + + + +TransactionMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#transaction) + +- Inherited from `BaseContext.transaction` + + + +UntrustedDataMembersOnMfaPushChallengePush}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#untrusteddata) + +- Overrides `BaseContext.untrustedData` + + + +UserMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#user) + +- Inherited from `BaseContext.user` + + + + +{/*> `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/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/screens/mfa-push-challenge-push/index.ts#L32) + +- Overrides `BaseContext.screenIdentifier` + + +## Methods + + +{/*> **continue**(`payload?`): `Promise`\<`void`\>*/} + +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 + + +WithRememberOptions}> +[`WithRememberOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/WithRememberOptions) + +Optional custom options to include with the request + + + +- Returns `Promise`\<`void`\> + +```typescript Example +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#continue) + + + + +{/*> **enterCodeManually**(`payload?`): `Promise`\<`void`\>*/} + +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 + + +CustomOptions}> +[`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CustomOptions) + +Optional custom options to include with the request + + + +- Returns `Promise`\<`void`\> + +```typescript Example +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#entercodemanually) + + + +Error[]}> +{/*> **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/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. + +- 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` + + + +MfaPushPollingControl}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#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. + + +MfaPollingOptions}> +[`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). + + + +- 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. + +```ts Example +// 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#pollingmanager) + + + + +{/*> **resendPushNotification**(`payload?`): `Promise`\<`void`\>*/} + +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 + + +WithRememberOptions}> +[`WithRememberOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/WithRememberOptions) + +Optional custom options to include with the request + + + +- Returns `Promise`\<`void`\> + +```typescript Example +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#resendpushnotification) + + + + +{/*> **tryAnotherMethod**(`payload?`): `Promise`\<`void`\>*/} + +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 + + +CustomOptions}> +[`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CustomOptions) + +Optional custom options to include with the request + + + +- Returns `Promise`\<`void`\> + +```typescript Example +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#tryanothermethod) + \ 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..5b6e8356f --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/MfaPushEnrollmentQr.mdx @@ -0,0 +1,244 @@ +--- +title: "MfaPushEnrollmentQr" +--- + +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 + + + +```ts Example +import MfaPushEnrollmentQr from '@auth0/auth0-acul-js/mfa-push-enrollment-qr'; + +const mfaPushEnrollmentQr = new MfaPushEnrollmentQr(); +await mfaPushEnrollmentQr.pickAuthenticator(); +``` + + +- Extends `BaseContext` + +- Implements [`MfaPushEnrollmentQrMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaPushEnrollmentQrMembers) + +## Constructors + + +{/*> **new MfaPushEnrollmentQr**(): `MfaPushEnrollmentQr`*/} + +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 `MfaPushEnrollmentQr` + +- Overrides `BaseContext.constructor` + + +## Properties + +BrandingMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#branding) + +- Inherited from `BaseContext.branding` + + + +ClientMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#client) + +- Inherited from `BaseContext.client` + + + +OrganizationMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#organization) + +- Inherited from `BaseContext.organization` + + + +PromptMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#prompt) + +- Inherited from `BaseContext.prompt` + + + +ScreenMembersOnMfaPushEnrollmentQr}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#screen) + +- Overrides `BaseContext.screen` + + + +TenantMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#tenant) + +- Inherited from `BaseContext.tenant` + + + +TransactionMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#transaction) + +- Inherited from `BaseContext.transaction` + + + +UntrustedDataMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#untrusteddata) + +- Inherited from `BaseContext.untrustedData` + + + +UserMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#user) + +- Inherited from `BaseContext.user` + + + + +{/*> `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/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/screens/mfa-push-enrollment-qr/index.ts#L21) + +- Overrides `BaseContext.screenIdentifier` + + +## Methods + +Error[]}> +{/*> **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/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. + +- 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` + + + + +{/*> **pickAuthenticator**(`payload?`): `Promise`\<`void`\>*/} + +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. + + +CustomOptions}> +[`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CustomOptions) + +Optional custom options to include with the request + + + +- Returns `Promise`\<`void`\> + +```typescript Example +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#pickauthenticator) + + + +MfaPushPollingControl}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#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. + + +MfaPollingOptions}> +[`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). + + + +- 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. + +```ts Example +// 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#pollingmanager) + \ 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..d0c408a06 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/MfaPushList.mdx @@ -0,0 +1,214 @@ +--- +title: "MfaPushList" +--- + +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 + + + +```ts Example +import MfaPushList from '@auth0/auth0-acul-js/mfa-push-list'; + +const mfaPushList = new MfaPushList(); +await mfaPushList.selectMfaPushDevice({ deviceIndex: 0 }); +``` + + +- Extends `BaseContext` + +- Implements [`MfaPushListMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaPushListMembers) + +## Constructors + + +{/*> **new MfaPushList**(): `MfaPushList`*/} + +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 `MfaPushList` + +- Overrides `BaseContext.constructor` + + +## Properties + +BrandingMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#branding) + +- Inherited from `BaseContext.branding` + + + +ClientMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#client) + +- Inherited from `BaseContext.client` + + + +OrganizationMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#organization) + +- Inherited from `BaseContext.organization` + + + +PromptMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#prompt) + +- Inherited from `BaseContext.prompt` + + + +ScreenMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#screen) + +- Inherited from `BaseContext.screen` + + + +TenantMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#tenant) + +- Inherited from `BaseContext.tenant` + + + +TransactionMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#transaction) + +- Inherited from `BaseContext.transaction` + + + +UntrustedDataMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#untrusteddata) + +- Inherited from `BaseContext.untrustedData` + + + +UserMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#user) + +- Inherited from `BaseContext.user` + + + + +{/*> `static` **screenIdentifier**: `string` = `ScreenIds.MFA_PUSH_LIST`*/} + +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 `BaseContext.screenIdentifier` + + +## Methods + +Error[]}> +{/*> **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/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. + +- 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` + + + + +{/*> **goBack**(`payload?`): `Promise`\<`void`\>*/} + +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. + + +CustomOptions}> +[`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CustomOptions) + +Optional custom options to include with the request. + + + +- Returns `Promise`\<`void`\> + +```typescript Example +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#goback) + + + + +{/*> **selectMfaPushDevice**(`payload`): `Promise`\<`void`\>*/} + +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. + + +SelectMfaPushDeviceOptions}> +[`SelectMfaPushDeviceOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/SelectMfaPushDeviceOptions) + +The options containing the device index. + + + +- Returns `Promise`\<`void`\> + +```typescript Example +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#selectmfapushdevice) + \ 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..0277948a5 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/MfaPushWelcome.mdx @@ -0,0 +1,214 @@ +--- +title: "MfaPushWelcome" +--- + +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) + + + +```ts Example +import MfaPushWelcome from '@auth0/auth0-acul-js/mfa-push-welcome'; + +const mfaPushWelcome = new MfaPushWelcome(); +await mfaPushWelcome.enroll(); +``` + + +- Extends `BaseContext` + +- Implements [`MfaPushWelcomeMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaPushWelcomeMembers) + +## Constructors + + +{/*> **new MfaPushWelcome**(): `MfaPushWelcome`*/} + +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. + +- Returns `MfaPushWelcome` + +- Overrides `BaseContext.constructor` + + +## Properties + +BrandingMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#branding) + +- Inherited from `BaseContext.branding` + + + +ClientMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#client) + +- Inherited from `BaseContext.client` + + + +OrganizationMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#organization) + +- Inherited from `BaseContext.organization` + + + +PromptMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#prompt) + +- Inherited from `BaseContext.prompt` + + + +ScreenMembersOnMfaPushWelcome}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#screen) + +- Overrides `BaseContext.screen` + + + +TenantMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#tenant) + +- Inherited from `BaseContext.tenant` + + + +TransactionMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#transaction) + +- Inherited from `BaseContext.transaction` + + + +UntrustedDataMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#untrusteddata) + +- Inherited from `BaseContext.untrustedData` + + + +UserMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#user) + +- Inherited from `BaseContext.user` + + + + +{/*> `static` **screenIdentifier**: `string` = `ScreenIds.MFA_PUSH_WELCOME`*/} + +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 `BaseContext.screenIdentifier` + + +## Methods + + +{/*> **enroll**(`payload?`): `Promise`\<`void`\>*/} + +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. + + +CustomOptions}> +[`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CustomOptions) + +Optional custom options to include with the request. + + + +- Returns `Promise`\<`void`\> + +```typescript Example +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#enroll) + + + +Error[]}> +{/*> **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/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. + +- 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` + + + + +{/*> **pickAuthenticator**(`payload?`): `Promise`\<`void`\>*/} + +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. + + +CustomOptions}> +[`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CustomOptions) + +Optional custom options to include with the request. + + + +- Returns `Promise`\<`void`\> + +```typescript Example +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#pickauthenticator) + \ 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..016b2e5df --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/MfaRecoveryCodeChallenge.mdx @@ -0,0 +1,232 @@ +--- +title: "MfaRecoveryCodeChallenge" +--- + +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. + + + +```ts Example +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); + } +} +``` + + +- Extends `BaseContext` + +- Implements [`MfaRecoveryCodeChallengeMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaRecoveryCodeChallengeMembers) + +## Constructors + + +{/*> **new MfaRecoveryCodeChallenge**(): `MfaRecoveryCodeChallenge`*/} + +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. + +- Returns `MfaRecoveryCodeChallenge` + +- Overrides `BaseContext.constructor` + + +## Properties + +BrandingMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#branding) + +- Inherited from `BaseContext.branding` + + + +ClientMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#client) + +- Inherited from `BaseContext.client` + + + +OrganizationMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#organization) + +- Inherited from `BaseContext.organization` + + + +PromptMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#prompt) + +- Inherited from `BaseContext.prompt` + + + +ScreenMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#screen) + +- Inherited from `BaseContext.screen` + + + +TenantMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#tenant) + +- Inherited from `BaseContext.tenant` + + + +TransactionMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#transaction) + +- Inherited from `BaseContext.transaction` + + + +UntrustedDataMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#untrusteddata) + +- Inherited from `BaseContext.untrustedData` + + + +UserMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#user) + +- Inherited from `BaseContext.user` + + + + +{/*> `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/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/screens/mfa-recovery-code-challenge/index.ts#L15) + +- Overrides `BaseContext.screenIdentifier` + + +## Methods + + +{/*> **continue**(`payload`): `Promise`\<`void`\>*/} + +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. + + +MfaRecoveryCodeChallengeContinueOptions}> +[`MfaRecoveryCodeChallengeContinueOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaRecoveryCodeChallengeContinueOptions) + +The payload containing the recovery code and optional custom options. + + + +- Returns `Promise`\<`void`\> + +```typescript Example +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#continue) + + + +Error[]}> +{/*> **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/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. + +- 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` + + + + +{/*> **tryAnotherMethod**(`payload?`): `Promise`\<`void`\>*/} + +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. + + +CustomOptions}> +[`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CustomOptions) + +Optional payload. + + + +- Returns `Promise`\<`void`\> + +```typescript Example +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#tryanothermethod) + \ 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..37cd7ba34 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/MfaRecoveryCodeChallengeNewCode.mdx @@ -0,0 +1,223 @@ +--- +title: "MfaRecoveryCodeChallengeNewCode" +--- + +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 + + + +```ts Example +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 +} +``` + + +- Extends `BaseContext` + +- Implements [`MfaRecoveryCodeChallengeNewCodeMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaRecoveryCodeChallengeNewCodeMembers) + +## Constructors + + +{/*> **new MfaRecoveryCodeChallengeNewCode**(): `MfaRecoveryCodeChallengeNewCode`*/} + +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. + +- Returns `MfaRecoveryCodeChallengeNewCode` + +#### Throws + +If the Universal Login Context is not available or if the screen name doesn't match. + +- Overrides `BaseContext.constructor` + + +## Properties + +BrandingMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#branding) + +- Inherited from `BaseContext.branding` + + + +ClientMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#client) + +- Inherited from `BaseContext.client` + + + +OrganizationMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#organization) + +- Inherited from `BaseContext.organization` + + + +PromptMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#prompt) + +- Inherited from `BaseContext.prompt` + + + +ScreenMembersOnMfaRecoveryCodeChallengeNewCode}> +{/*> **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/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. + +- 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#screen) + +- Overrides `BaseContext.screen` + + + +TenantMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#tenant) + +- Inherited from `BaseContext.tenant` + + + +TransactionMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#transaction) + +- Inherited from `BaseContext.transaction` + + + +UntrustedDataMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#untrusteddata) + +- Inherited from `BaseContext.untrustedData` + + + +UserMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#user) + +- Inherited from `BaseContext.user` + + + + +{/*> `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/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. + +- Overrides `BaseContext.screenIdentifier` + + +## Methods + + +{/*> **continue**(`payload?`): `Promise`\<`void`\>*/} + +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 +with the required `state`, `action`, and `saved` parameters. + + +MfaRecoveryCodeChallengeNewCodeContinueOptions}> +[`MfaRecoveryCodeChallengeNewCodeContinueOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaRecoveryCodeChallengeNewCodeContinueOptions) + +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 + +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'). + +```typescript Example +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#continue) + + + +Error[]}> +{/*> **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/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. + +- 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` + \ 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..131a3f556 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/MfaRecoveryCodeEnrollment.mdx @@ -0,0 +1,206 @@ +--- +title: "MfaRecoveryCodeEnrollment" +--- + +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. + + + +```ts Example +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); + } +}; +``` + + +- Extends `BaseContext` + +- Implements [`MfaRecoveryCodeEnrollmentMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaRecoveryCodeEnrollmentMembers) + +## Constructors + + +{/*> **new MfaRecoveryCodeEnrollment**(): `MfaRecoveryCodeEnrollment`*/} + +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. + +- Returns `MfaRecoveryCodeEnrollment` + +- Overrides `BaseContext.constructor` + + +## Properties + +BrandingMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#branding) + +- Inherited from `BaseContext.branding` + + + +ClientMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#client) + +- Inherited from `BaseContext.client` + + + +OrganizationMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#organization) + +- Inherited from `BaseContext.organization` + + + +PromptMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#prompt) + +- Inherited from `BaseContext.prompt` + + + +ScreenMembersOnMfaRecoveryCodeEnrollment}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#screen) + +- Overrides `BaseContext.screen` + + + +TenantMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#tenant) + +- Inherited from `BaseContext.tenant` + + + +TransactionMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#transaction) + +- Inherited from `BaseContext.transaction` + + + +UntrustedDataMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#untrusteddata) + +- Inherited from `BaseContext.untrustedData` + + + +UserMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#user) + +- Inherited from `BaseContext.user` + + + + +{/*> `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/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/screens/mfa-recovery-code-enrollment/index.ts#L19) + +- Overrides `BaseContext.screenIdentifier` + + +## Methods + + +{/*> **continue**(`payload`): `Promise`\<`void`\>*/} + +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. +It redirects to the next screen in the authentication flow. + + +MfaRecoveryCodeEnrollmentContinueOptions}> +[`MfaRecoveryCodeEnrollmentContinueOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaRecoveryCodeEnrollmentContinueOptions) + +An object containing any custom options. + + + +- Returns `Promise`\<`void`\> + +A promise that resolves when the action is successfully submitted. + +```typescript Example +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#continue) + + + +Error[]}> +{/*> **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/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. + +- 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` + \ 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..55e3f3996 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/MfaSmsChallenge.mdx @@ -0,0 +1,349 @@ +--- +title: "MfaSmsChallenge" +--- + +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. + + + +```ts Example +import MfaSmsChallenge from '@auth0/auth0-acul-js/mfa-sms-challenge'; + +const mfaSmsChallenge = new MfaSmsChallenge(); +await mfaSmsChallenge.continueMfaSmsChallenge({ + code: '123456', + rememberDevice: true, +}); +``` + + +- Extends `BaseContext` + +- Implements [`MfaSmsChallengeMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaSmsChallengeMembers) + +## Constructors + + +{/*> **new MfaSmsChallenge**(): `MfaSmsChallenge`*/} + +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 + +- Returns `MfaSmsChallenge` + +- Overrides `BaseContext.constructor` + + +## Properties + +BrandingMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#branding) + +- Inherited from `BaseContext.branding` + + + +ClientMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#client) + +- Inherited from `BaseContext.client` + + + +OrganizationMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#organization) + +- Inherited from `BaseContext.organization` + + + +PromptMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#prompt) + +- Inherited from `BaseContext.prompt` + + + +ScreenMembersOnMfaSmsChallenge}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#screen) + +- Overrides `BaseContext.screen` + + + +TenantMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#tenant) + +- Inherited from `BaseContext.tenant` + + + +TransactionMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#transaction) + +- Inherited from `BaseContext.transaction` + + + +UntrustedDataMembersOnMfaSmsChallenge}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#untrusteddata) + +- Overrides `BaseContext.untrustedData` + + + +UserMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#user) + +- Inherited from `BaseContext.user` + + + + +{/*> `static` **screenIdentifier**: `string` = `ScreenIds.MFA_SMS_CHALLENGE`*/} + +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 `BaseContext.screenIdentifier` + + +## Methods + + +{/*> **continueMfaSmsChallenge**(`payload`): `Promise`\<`void`\>*/} + +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. + + +MfaSmsChallengeOptions}> +[`MfaSmsChallengeOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaSmsChallengeOptions) + +The payload containing the code and rememberDevice option. + + + +- Returns `Promise`\<`void`\> + +```typescript Example +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#continuemfasmschallenge) + + + + +{/*> **getACall**(`payload?`): `Promise`\<`void`\>*/} + +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. + + +CustomOptions}> +[`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CustomOptions) + +Optional payload. + + + +- Returns `Promise`\<`void`\> + +```typescript Example +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#getacall) + + + +Error[]}> +{/*> **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/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. + +- 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` + + + + +{/*> **pickSms**(`payload?`): `Promise`\<`void`\>*/} + +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. + + +CustomOptions}> +[`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CustomOptions) + +Optional payload. + + + +- Returns `Promise`\<`void`\> + +```typescript Example +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#picksms) + + + + +{/*> **resendCode**(`payload?`): `Promise`\<`void`\>*/} + +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. + + +CustomOptions}> +[`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CustomOptions) + +Optional payload. + + + +- Returns `Promise`\<`void`\> + +```typescript Example +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#resendcode) + + + +ResendControl}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/screens/mfa-sms-challenge/index.ts#L180) + +**`Utility Feature`** + +Gets resend functionality with timeout management for this screen + + +StartResendOptions}> +[`StartResendOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/StartResendOptions) + +Configuration options for resend functionality + + + +- Returns [`ResendControl`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResendControl) + +ResendControl object with startResend method + +```typescript Example +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#resendmanager) + + + + +{/*> **tryAnotherMethod**(`payload?`): `Promise`\<`void`\>*/} + +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. + + +CustomOptions}> +[`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CustomOptions) + +Optional payload. + + + +- Returns `Promise`\<`void`\> + +```typescript Example +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#tryanothermethod) + \ 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..6f59d2809 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/MfaSmsEnrollment.mdx @@ -0,0 +1,254 @@ +--- +title: "MfaSmsEnrollment" +--- + +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. + + + +```ts Example +import MfaSmsEnrollment from '@auth0/auth0-acul-js/mfa-sms-enrollment'; + +const mfaSmsEnrollment = new MfaSmsEnrollment(); +await mfaSmsEnrollment.pickCountryCode(); +``` + + +- Extends `BaseContext` + +- Implements [`MfaSmsEnrollmentMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaSmsEnrollmentMembers) + +## Constructors + + +{/*> **new MfaSmsEnrollment**(): `MfaSmsEnrollment`*/} + +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. + +- Returns `MfaSmsEnrollment` + +- Overrides `BaseContext.constructor` + + +## Properties + +BrandingMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#branding) + +- Inherited from `BaseContext.branding` + + + +ClientMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#client) + +- Inherited from `BaseContext.client` + + + +OrganizationMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#organization) + +- Inherited from `BaseContext.organization` + + + +PromptMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#prompt) + +- Inherited from `BaseContext.prompt` + + + +ScreenMembersOnMfaSmsEnrollment}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#screen) + +- Overrides `BaseContext.screen` + + + +TenantMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#tenant) + +- Inherited from `BaseContext.tenant` + + + +TransactionMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#transaction) + +- Inherited from `BaseContext.transaction` + + + +UntrustedDataMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#untrusteddata) + +- Inherited from `BaseContext.untrustedData` + + + +UserMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#user) + +- Inherited from `BaseContext.user` + + + + +{/*> `static` **screenIdentifier**: `string` = `ScreenIds.MFA_SMS_ENROLLMENT`*/} + +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 `BaseContext.screenIdentifier` + + +## Methods + + +{/*> **continueEnrollment**(`payload`): `Promise`\<`void`\>*/} + +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. + + +MfaSmsEnrollmentOptions}> +[`MfaSmsEnrollmentOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaSmsEnrollmentOptions) + +The phone number to use for enrollment. + + + +- Returns `Promise`\<`void`\> + +A promise that resolves when the enrollment process is complete. + +#### Throws + +If the phone number is missing. + +```typescript Example +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#continueenrollment) + + + +Error[]}> +{/*> **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/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. + +- 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` + + + + +{/*> **pickCountryCode**(`payload?`): `Promise`\<`void`\>*/} + +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. + + +CustomOptions}> +[`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CustomOptions) + +Optional custom options to include in the request. + + + +- Returns `Promise`\<`void`\> + +A promise that resolves when the action is complete. + +```typescript Example +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#pickcountrycode) + + + + +{/*> **tryAnotherMethod**(`payload?`): `Promise`\<`void`\>*/} + +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. + + +CustomOptions}> +[`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CustomOptions) + +Optional custom options to include in the request. + + + +- Returns `Promise`\<`void`\> + +A promise that resolves when the action is complete. + +```typescript Example +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#tryanothermethod) + \ 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..8dec41516 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/MfaSmsList.mdx @@ -0,0 +1,230 @@ +--- +title: "MfaSmsList" +--- + +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. + + + +```ts Example +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}); +} +``` + + +- Extends `BaseContext` + +- Implements [`MfaSmsListMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaSmsListMembers) + +## Constructors + + +{/*> **new MfaSmsList**(): `MfaSmsList`*/} + +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 `MfaSmsList` + +- Overrides `BaseContext.constructor` + + +## Properties + +BrandingMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#branding) + +- Inherited from `BaseContext.branding` + + + +ClientMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#client) + +- Inherited from `BaseContext.client` + + + +OrganizationMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#organization) + +- Inherited from `BaseContext.organization` + + + +PromptMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#prompt) + +- Inherited from `BaseContext.prompt` + + + +ScreenMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#screen) + +- Inherited from `BaseContext.screen` + + + +TenantMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#tenant) + +- Inherited from `BaseContext.tenant` + + + +TransactionMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#transaction) + +- Inherited from `BaseContext.transaction` + + + +UntrustedDataMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#untrusteddata) + +- Inherited from `BaseContext.untrustedData` + + + +UserMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#user) + +- Inherited from `BaseContext.user` + + + + +{/*> `static` **screenIdentifier**: `string` = `ScreenIds.MFA_SMS_LIST`*/} + +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 `BaseContext.screenIdentifier` + + +## Methods + + +{/*> **backAction**(`payload?`): `Promise`\<`void`\>*/} + +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. + + +CustomOptions}> +[`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CustomOptions) + +Optional payload for the action. + + + +- Returns `Promise`\<`void`\> + +```typescript Example +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#backaction) + + + +Error[]}> +{/*> **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/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. + +- 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` + + + + +{/*> **selectPhoneNumber**(`payload?`): `Promise`\<`void`\>*/} + +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. + + +MfaSmsListOptions}> +[`MfaSmsListOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaSmsListOptions) + +Optional payload for the action. + + + +- Returns `Promise`\<`void`\> + +#### Throws + +If the index is out of bounds. + +```typescript Example +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#selectphonenumber) + \ 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..182be2cb8 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/MfaVoiceChallenge.mdx @@ -0,0 +1,354 @@ +--- +title: "MfaVoiceChallenge" +--- + +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. + +This screen is displayed when a user needs to verify their identity using a voice call +as part of a multi-factor authentication flow. + + + +```ts Example +const mfaVoiceChallenge = new MfaVoiceChallenge(); +mfaVoiceChallenge.continue({ + code: '123456', + rememberDevice: true +}); +``` + + +- Extends `BaseContext` + +- Implements [`MfaVoiceChallengeMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaVoiceChallengeMembers) + +## Constructors + + +{/*> **new MfaVoiceChallenge**(): `MfaVoiceChallenge`*/} + +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. + +- Returns `MfaVoiceChallenge` + +- Overrides `BaseContext.constructor` + + +## Properties + +BrandingMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#branding) + +- Inherited from `BaseContext.branding` + + + +ClientMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#client) + +- Inherited from `BaseContext.client` + + + +OrganizationMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#organization) + +- Inherited from `BaseContext.organization` + + + +PromptMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#prompt) + +- Inherited from `BaseContext.prompt` + + + +ScreenMembersOnMfaVoiceChallenge}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#screen) + +- Overrides `BaseContext.screen` + + + +TenantMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#tenant) + +- Inherited from `BaseContext.tenant` + + + +TransactionMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#transaction) + +- Inherited from `BaseContext.transaction` + + + +UntrustedDataMembersOnMfaVoiceChallenge}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#untrusteddata) + +- Overrides `BaseContext.untrustedData` + + + +UserMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#user) + +- Inherited from `BaseContext.user` + + + + +{/*> `static` **screenIdentifier**: `string` = `ScreenIds.MFA_VOICE_CHALLENGE`*/} + +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 + +- Overrides `BaseContext.screenIdentifier` + + +## Methods + + +{/*> **continue**(`payload`): `Promise`\<`void`\>*/} + +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. + + +MfaVoiceChallengeContinueOptions}> +[`MfaVoiceChallengeContinueOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaVoiceChallengeContinueOptions) + +Object containing the verification code and optional parameters + + + +- Returns `Promise`\<`void`\> + +Promise that resolves when the code is successfully validated + +```typescript Example +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#continue) + + + +Error[]}> +{/*> **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/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. + +- 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` + + + + +{/*> **pickPhone**(`payload?`): `Promise`\<`void`\>*/} + +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. + + +CustomOptions}> +[`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CustomOptions) + +Optional custom parameters + + + +- Returns `Promise`\<`void`\> + +Promise that resolves when navigation is complete + +```typescript Example +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#pickphone) + + + + +{/*> **resendCode**(`payload?`): `Promise`\<`void`\>*/} + +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. + + +CustomOptions}> +[`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CustomOptions) + +Optional custom parameters + + + +- Returns `Promise`\<`void`\> + +Promise that resolves when the new code is sent + +```typescript Example +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#resendcode) + + + +ResendControl}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/screens/mfa-voice-challenge/index.ts#L203) + +**`Utility Feature`** + +Gets resend functionality with timeout management for this screen + + +StartResendOptions}> +[`StartResendOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/StartResendOptions) + +Configuration options for resend functionality + + + +- Returns [`ResendControl`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResendControl) + +ResendControl object with startResend method + +```typescript Example +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#resendmanager) + + + + +{/*> **switchToSms**(`payload?`): `Promise`\<`void`\>*/} + +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. + + +CustomOptions}> +[`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CustomOptions) + +Optional custom parameters + + + +- Returns `Promise`\<`void`\> + +Promise that resolves when switching is complete + +```typescript Example +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#switchtosms) + + + + +{/*> **tryAnotherMethod**(`payload?`): `Promise`\<`void`\>*/} + +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. + + +CustomOptions}> +[`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CustomOptions) + +Optional custom parameters + + + +- Returns `Promise`\<`void`\> + +Promise that resolves when navigation is complete + +```typescript Example +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#tryanothermethod) + \ 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..7c517f7d4 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/MfaVoiceEnrollment.mdx @@ -0,0 +1,264 @@ +--- +title: "MfaVoiceEnrollment" +--- + +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. + + + +```ts Example +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); + } +}; +``` + + +- Extends `BaseContext` + +- Implements [`MfaVoiceEnrollmentMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaVoiceEnrollmentMembers) + +## Constructors + + +{/*> **new MfaVoiceEnrollment**(): `MfaVoiceEnrollment`*/} + +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. + +- Returns `MfaVoiceEnrollment` + +- Overrides `BaseContext.constructor` + + +## Properties + +BrandingMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#branding) + +- Inherited from `BaseContext.branding` + + + +ClientMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#client) + +- Inherited from `BaseContext.client` + + + +OrganizationMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#organization) + +- Inherited from `BaseContext.organization` + + + +PromptMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#prompt) + +- Inherited from `BaseContext.prompt` + + + +ScreenMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#screen) + +- Inherited from `BaseContext.screen` + + + +TenantMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#tenant) + +- Inherited from `BaseContext.tenant` + + + +TransactionMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#transaction) + +- Inherited from `BaseContext.transaction` + + + +UntrustedDataMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#untrusteddata) + +- Inherited from `BaseContext.untrustedData` + + + +UserMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#user) + +- Inherited from `BaseContext.user` + + + + +{/*> `static` **screenIdentifier**: `string` = `ScreenIds.MFA_VOICE_ENROLLMENT`*/} + +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 `BaseContext.screenIdentifier` + + +## Methods + + +{/*> **continue**(`payload`): `Promise`\<`void`\>*/} + +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. + + +MfaVoiceEnrollmentContinueOptions}> +[`MfaVoiceEnrollmentContinueOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaVoiceEnrollmentContinueOptions) + +Optional payload. + + + +- Returns `Promise`\<`void`\> + +```typescript Example +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#continue) + + + +Error[]}> +{/*> **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/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. + +- 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` + + + + +{/*> **selectPhoneCountryCode**(`payload?`): `Promise`\<`void`\>*/} + +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 + + +CustomOptions}> +[`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CustomOptions) + +Optional payload. + + + +- Returns `Promise`\<`void`\> + +```typescript Example +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#selectphonecountrycode) + + + + +{/*> **tryAnotherMethod**(`payload?`): `Promise`\<`void`\>*/} + +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 + + +CustomOptions}> +[`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CustomOptions) + +Optional payload. + + + +- Returns `Promise`\<`void`\> + +```typescript Example +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#tryanothermethod) + \ 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..8cae3f3ff --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/MfaWebAuthnChangeKeyNickname.mdx @@ -0,0 +1,199 @@ +--- +title: "MfaWebAuthnChangeKeyNickname" +--- + +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 + + +- Extends `BaseContext` + +- Implements [`MfaWebAuthnChangeKeyNicknameMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaWebAuthnChangeKeyNicknameMembers) + +## Constructors + + +{/*> **new MfaWebAuthnChangeKeyNickname**(): `MfaWebAuthnChangeKeyNickname`*/} + +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 +`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` + + +## Properties + +BrandingMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#branding) + +- Inherited from `BaseContext.branding` + + + +ClientMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#client) + +- Inherited from `BaseContext.client` + + + +OrganizationMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#organization) + +- Inherited from `BaseContext.organization` + + + +PromptMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#prompt) + +- Inherited from `BaseContext.prompt` + + + +ScreenMembersOnMfaWebAuthnChangeKeyNickname}> +{/*> **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/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. + +- 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#screen) + +- Overrides `BaseContext.screen` + + + +TenantMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#tenant) + +- Inherited from `BaseContext.tenant` + + + +TransactionMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#transaction) + +- Inherited from `BaseContext.transaction` + + + +UntrustedDataMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#untrusteddata) + +- Inherited from `BaseContext.untrustedData` + + + +UserMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#user) + +- Inherited from `BaseContext.user` + + + + +{/*> `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/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/screens/mfa-webauthn-change-key-nickname/index.ts#L17) + +- Overrides `BaseContext.screenIdentifier` + + +## Methods + + +{/*> **continueWithNewNickname**(`payload`): `Promise`\<`void`\>*/} + +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 +required `action: "default"`, to the `/u/mfa-webauthn-change-key-nickname` endpoint. + + +MfaWebAuthnChangeKeyNicknameContinueOptions}> +[`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. + + + +- 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#continuewithnewnickname) + + + +Error[]}> +{/*> **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/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. + +- 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` + \ 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..6204b315c --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/MfaWebAuthnEnrollmentSuccess.mdx @@ -0,0 +1,224 @@ +--- +title: "MfaWebAuthnEnrollmentSuccess" +--- + +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 + + + +```ts Example +// 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 + } +} +``` + + +- Extends `BaseContext` + +- Implements [`MfaWebAuthnEnrollmentSuccessMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaWebAuthnEnrollmentSuccessMembers) + +## Constructors + + +{/*> **new MfaWebAuthnEnrollmentSuccess**(): `MfaWebAuthnEnrollmentSuccess`*/} + +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` +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` + + +## Properties + +BrandingMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#branding) + +- Inherited from `BaseContext.branding` + + + +ClientMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#client) + +- Inherited from `BaseContext.client` + + + +OrganizationMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#organization) + +- Inherited from `BaseContext.organization` + + + +PromptMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#prompt) + +- Inherited from `BaseContext.prompt` + + + +ScreenMembersOnMfaWebAuthnEnrollmentSuccess}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#screen) + +- Overrides `BaseContext.screen` + + + +TenantMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#tenant) + +- Inherited from `BaseContext.tenant` + + + +TransactionMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#transaction) + +- Inherited from `BaseContext.transaction` + + + +UntrustedDataMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#untrusteddata) + +- Inherited from `BaseContext.untrustedData` + + + +UserMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#user) + +- Inherited from `BaseContext.user` + + + + +{/*> `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/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/screens/mfa-webauthn-enrollment-success/index.ts#L31) + +static + +- Overrides `BaseContext.screenIdentifier` + + +## Methods + + +{/*> **continue**(`payload?`): `Promise`\<`void`\>*/} + +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 +with the action set to "default", indicating the user is proceeding from this success screen. + + +WebAuthnEnrollSuccessContinueOptions}> +[`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. + + + +- 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. + +```typescript Example +// 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#continue) + + + +Error[]}> +{/*> **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/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. + +- 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` + \ 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..c3dbd152a --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/MfaWebAuthnError.mdx @@ -0,0 +1,299 @@ +--- +title: "MfaWebAuthnError" +--- + +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 + + + +```ts Example +// Assuming 'sdk' is an instance of MfaWebAuthnError +await sdk.tryAgain(); +``` + + +- Extends `BaseContext` + +- Implements [`MfaWebAuthnErrorMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaWebAuthnErrorMembers) + +## Constructors + + +{/*> **new MfaWebAuthnError**(): `MfaWebAuthnError`*/} + +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`. + +- 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` + + +## Properties + +BrandingMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#branding) + +- Inherited from `BaseContext.branding` + + + +ClientMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#client) + +- Inherited from `BaseContext.client` + + + +OrganizationMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#organization) + +- Inherited from `BaseContext.organization` + + + +PromptMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#prompt) + +- Inherited from `BaseContext.prompt` + + + +ScreenMembersOnMfaWebAuthnError}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#screen) + +- Overrides `BaseContext.screen` + + + +TenantMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#tenant) + +- Inherited from `BaseContext.tenant` + + + +TransactionMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#transaction) + +- Inherited from `BaseContext.transaction` + + + +UntrustedDataMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#untrusteddata) + +- Inherited from `BaseContext.untrustedData` + + + +UserMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#user) + +- Inherited from `BaseContext.user` + + + + +{/*> `static` **screenIdentifier**: `string` = `ScreenIds.MFA_WEBAUTHN_ERROR`*/} + +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 + +- Overrides `BaseContext.screenIdentifier` + + +## Methods + +Error[]}> +{/*> **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/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. + +- 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` + + + + +{/*> **noThanks**(`payload?`): `Promise`\<`void`\>*/} + +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. + + +CustomOptions}> +[`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CustomOptions) + +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 + +Throws an error if the form submission fails. + +```typescript Example +// 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#nothanks) + + + + +{/*> **tryAgain**(`payload?`): `Promise`\<`void`\>*/} + +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 +initially attempted (e.g., back to the MFA challenge or enrollment screen for WebAuthn). + + +CustomOptions}> +[`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CustomOptions) + +Optional custom parameters to be sent with the request. + + + +- Returns `Promise`\<`void`\> + +A promise that resolves upon successful submission of the 'tryagain' action. + +#### Throws + +Throws an error if the form submission fails. + +```typescript Example +// 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#tryagain) + + + + +{/*> **tryAnotherMethod**(`payload?`): `Promise`\<`void`\>*/} + +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. + + +CustomOptions}> +[`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/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. + +```typescript Example +// 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#tryanothermethod) + + + + +{/*> **usePassword**(`payload?`): `Promise`\<`void`\>*/} + +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). + + +CustomOptions}> +[`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CustomOptions) + +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 + +Throws an error if the form submission fails. + +```typescript Example +// 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#usepassword) + \ 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..45be2a12f --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/MfaWebAuthnNotAvailableError.mdx @@ -0,0 +1,212 @@ +--- +title: "MfaWebAuthnNotAvailableError" +--- + +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 + + + +```ts Example +// 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. +} +``` + + +- Extends `BaseContext` + +- Implements [`MfaWebAuthnNotAvailableErrorMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaWebAuthnNotAvailableErrorMembers) + +## Constructors + + +{/*> **new MfaWebAuthnNotAvailableError**(): `MfaWebAuthnNotAvailableError`*/} + +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`. + +- 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` + + +## Properties + +BrandingMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#branding) + +- Inherited from `BaseContext.branding` + + + +ClientMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#client) + +- Inherited from `BaseContext.client` + + + +OrganizationMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#organization) + +- Inherited from `BaseContext.organization` + + + +PromptMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#prompt) + +- Inherited from `BaseContext.prompt` + + + +ScreenMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#screen) + +- Inherited from `BaseContext.screen` + + + +TenantMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#tenant) + +- Inherited from `BaseContext.tenant` + + + +TransactionMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#transaction) + +- Inherited from `BaseContext.transaction` + + + +UntrustedDataMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#untrusteddata) + +- Inherited from `BaseContext.untrustedData` + + + +UserMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#user) + +- Inherited from `BaseContext.user` + + + + +{/*> `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/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/screens/mfa-webauthn-not-available-error/index.ts#L24) + +static + +- Overrides `BaseContext.screenIdentifier` + + +## Methods + +Error[]}> +{/*> **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/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. + +- 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` + + + + +{/*> **tryAnotherMethod**(`payload?`): `Promise`\<`void`\>*/} + +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. +This action navigates the user to a screen where they can choose from other available/enrolled MFA factors. + + +CustomOptions}> +[`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/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). + +```typescript Example +// 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#tryanothermethod) + \ 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..d4a1539d8 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/MfaWebAuthnPlatformChallenge.mdx @@ -0,0 +1,256 @@ +--- +title: "MfaWebAuthnPlatformChallenge" +--- + +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 + + +- Extends `BaseContext` + +- Implements [`MfaWebAuthnPlatformChallengeMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaWebAuthnPlatformChallengeMembers) + +## Constructors + + +{/*> **new MfaWebAuthnPlatformChallenge**(): `MfaWebAuthnPlatformChallenge`*/} + +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`. + +- 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` + + +## Properties + +BrandingMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#branding) + +- Inherited from `BaseContext.branding` + + + +ClientMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#client) + +- Inherited from `BaseContext.client` + + + +OrganizationMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#organization) + +- Inherited from `BaseContext.organization` + + + +PromptMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#prompt) + +- Inherited from `BaseContext.prompt` + + + +ScreenMembersOnMfaWebAuthnPlatformChallenge}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#screen) + +- Overrides `BaseContext.screen` + + + +TenantMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#tenant) + +- Inherited from `BaseContext.tenant` + + + +TransactionMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#transaction) + +- Inherited from `BaseContext.transaction` + + + +UntrustedDataMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#untrusteddata) + +- Inherited from `BaseContext.untrustedData` + + + +UserMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#user) + +- Inherited from `BaseContext.user` + + + + +{/*> `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/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/screens/mfa-webauthn-platform-challenge/index.ts#L36) + +static + +- Overrides `BaseContext.screenIdentifier` + + +## Methods + +Error[]}> +{/*> **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/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. + +- 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` + + + + +{/*> **reportBrowserError**(`options`): `Promise`\<`void`\>*/} + +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). +It sends the error details to the server with a specific action format. + + +MfaWebAuthnPlatformChallengeReportErrorOptions}> +[`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. + + + +- 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#reportbrowsererror) + + + + +{/*> **tryAnotherMethod**(`options?`): `Promise`\<`void`\>*/} + +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 +the user to an MFA factor selection screen. + + +MfaWebAuthnPlatformChallengeTryAnotherMethodOptions}> +[`MfaWebAuthnPlatformChallengeTryAnotherMethodOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaWebAuthnPlatformChallengeTryAnotherMethodOptions) + +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 + +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#tryanothermethod) + + + + +{/*> **verify**(`options?`): `Promise`\<`void`\>*/} + +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`, +calls `navigator.credentials.get()` (via the `getPasskeyCredentials` utility), +and then submits the resulting credential assertion to the Auth0 server. + + +VerifyPlatformAuthenticatorOptions}> +[`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. + + + +- 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#verify) + \ 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..633614392 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/MfaWebAuthnPlatformEnrollment.mdx @@ -0,0 +1,291 @@ +--- +title: "MfaWebAuthnPlatformEnrollment" +--- + +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 + + + +```ts Example +// 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 } }); + } +} +``` + + +- Extends `BaseContext` + +- Implements [`MfaWebAuthnPlatformEnrollmentMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaWebAuthnPlatformEnrollmentMembers) + +## Constructors + + +{/*> **new MfaWebAuthnPlatformEnrollment**(): `MfaWebAuthnPlatformEnrollment`*/} + +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. + +- 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` + + +## Properties + +BrandingMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#branding) + +- Inherited from `BaseContext.branding` + + + +ClientMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#client) + +- Inherited from `BaseContext.client` + + + +OrganizationMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#organization) + +- Inherited from `BaseContext.organization` + + + +PromptMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#prompt) + +- Inherited from `BaseContext.prompt` + + + +ScreenMembersOnMfaWebAuthnPlatformEnrollment}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#screen) + +- Overrides `BaseContext.screen` + + + +TenantMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#tenant) + +- Inherited from `BaseContext.tenant` + + + +TransactionMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#transaction) + +- Inherited from `BaseContext.transaction` + + + +UntrustedDataMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#untrusteddata) + +- Inherited from `BaseContext.untrustedData` + + + +UserMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#user) + +- Inherited from `BaseContext.user` + + + + +{/*> `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/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/screens/mfa-webauthn-platform-enrollment/index.ts#L32) + +static + +- Overrides `BaseContext.screenIdentifier` + + +## Methods + +Error[]}> +{/*> **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/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. + +- 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` + + + + +{/*> **refuseEnrollmentOnThisDevice**(`payload?`): `Promise`\<`void`\>*/} + +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. + + +CustomOptions}> +[`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CustomOptions) + +Optional custom parameters to be sent with the request. + + + +- 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#refuseenrollmentonthisdevice) + + + + +{/*> **reportBrowserError**(`payload`): `Promise`\<`void`\>*/} + +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. + + +ReportBrowserErrorOptions}> +[`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. + + + +- 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#reportbrowsererror) + + + + +{/*> **snoozeEnrollment**(`payload?`): `Promise`\<`void`\>*/} + +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. + + +CustomOptions}> +[`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CustomOptions) + +Optional custom parameters to be sent with the request. + + + +- 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#snoozeenrollment) + + + + +{/*> **submitPasskeyCredential**(`payload?`): `Promise`\<`void`\>*/} + +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. +This method internally calls `createPasskeyCredentials` (which wraps `navigator.credentials.create()`). + + +SubmitPasskeyCredentialOptions}> +[`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. + + + +- 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. + +```typescript Example +// 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#submitpasskeycredential) + \ 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..a7d0a9ade --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/MfaWebAuthnRoamingChallenge.mdx @@ -0,0 +1,287 @@ +--- +title: "MfaWebAuthnRoamingChallenge" +--- + +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 + + +- Extends `BaseContext` + +- Implements [`MfaWebAuthnRoamingChallengeMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaWebAuthnRoamingChallengeMembers) + +## Constructors + + +{/*> **new MfaWebAuthnRoamingChallenge**(): `MfaWebAuthnRoamingChallenge`*/} + +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. + +- 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` + + +## Properties + +BrandingMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#branding) + +- Inherited from `BaseContext.branding` + + + +ClientMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#client) + +- Inherited from `BaseContext.client` + + + +OrganizationMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#organization) + +- Inherited from `BaseContext.organization` + + + +PromptMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#prompt) + +- Inherited from `BaseContext.prompt` + + + +ScreenMembersOnMfaWebAuthnRoamingChallenge}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#screen) + +- Overrides `BaseContext.screen` + + + +TenantMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#tenant) + +- Inherited from `BaseContext.tenant` + + + +TransactionMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#transaction) + +- Inherited from `BaseContext.transaction` + + + +UntrustedDataMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#untrusteddata) + +- Inherited from `BaseContext.untrustedData` + + + +UserMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#user) + +- Inherited from `BaseContext.user` + + + + +{/*> `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/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/screens/mfa-webauthn-roaming-challenge/index.ts#L34) + +static + +- Overrides `BaseContext.screenIdentifier` + + +## Methods + +Error[]}> +{/*> **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/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. + +- 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` + + + + +{/*> **reportWebAuthnError**(`options`): `Promise`\<`void`\>*/} + +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 +`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}"`. + + +MfaWebAuthnRoamingChallengeReportErrorOptions}> +[`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. + + + +- Returns `Promise`\<`void`\> + +A promise that resolves when the error report is submitted. + +#### Throws + +Throws an error if the form submission fails. + +```typescript Example +// 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#reportwebauthnerror) + + + + +{/*> **tryAnotherMethod**(`options?`): `Promise`\<`void`\>*/} + +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 +the user to an MFA factor selection screen. + + +MfaWebAuthnRoamingChallengeTryAnotherMethodOptions}> +[`MfaWebAuthnRoamingChallengeTryAnotherMethodOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/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. + +```typescript Example +// 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#tryanothermethod) + + + + +{/*> **verify**(`options?`): `Promise`\<`void`\>*/} + +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`. +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. + + +VerifySecurityKeyOptions}> +[`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. + + + +- 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. + +```typescript Example +// 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#verify) + \ 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..3f2be8f16 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/MfaWebAuthnRoamingEnrollment.mdx @@ -0,0 +1,257 @@ +--- +title: "MfaWebAuthnRoamingEnrollment" +--- + +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). + + + +```ts Example +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) }); +``` + + +- Extends `BaseContext` + +- Implements [`MfaWebAuthnRoamingEnrollmentMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaWebAuthnRoamingEnrollmentMembers) + +## Constructors + + +{/*> **new MfaWebAuthnRoamingEnrollment**(): `MfaWebAuthnRoamingEnrollment`*/} + +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. + +- Returns `MfaWebAuthnRoamingEnrollment` + +- Overrides `BaseContext.constructor` + + +## Properties + +BrandingMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#branding) + +- Inherited from `BaseContext.branding` + + + +ClientMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#client) + +- Inherited from `BaseContext.client` + + + +OrganizationMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#organization) + +- Inherited from `BaseContext.organization` + + + +PromptMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#prompt) + +- Inherited from `BaseContext.prompt` + + + +ScreenMembersOnMfaWebAuthnRoamingEnrollment}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#screen) + +- Overrides `BaseContext.screen` + + + +TenantMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#tenant) + +- Inherited from `BaseContext.tenant` + + + +TransactionMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#transaction) + +- Inherited from `BaseContext.transaction` + + + +UntrustedDataMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#untrusteddata) + +- Inherited from `BaseContext.untrustedData` + + + +UserMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#user) + +- Inherited from `BaseContext.user` + + + + +{/*> `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/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/screens/mfa-webauthn-roaming-enrollment/index.ts#L23) + +- Overrides `BaseContext.screenIdentifier` + + +## Methods + + +{/*> **enroll**(`payload`): `Promise`\<`void`\>*/} + +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. + + +CustomOptions}> +[`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CustomOptions) + +Optional custom options to include with the request. + + + +- Returns `Promise`\<`void`\> + +```typescript Example +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#enroll) + + + +Error[]}> +{/*> **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/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. + +- 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` + + + + +{/*> **showError**(`payload`): `Promise`\<`void`\>*/} + +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. + + +ShowErrorOptions}> +[`ShowErrorOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ShowErrorOptions) + +The options containing the error details. + + + +- Returns `Promise`\<`void`\> + +```typescript Example +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#showerror) + + + + +{/*> **tryAnotherMethod**(`payload?`): `Promise`\<`void`\>*/} + +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. + + +MfaWebAuthnRoamingEnrollmentTryAnotherMethodOptions}> +[`MfaWebAuthnRoamingEnrollmentTryAnotherMethodOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaWebAuthnRoamingEnrollmentTryAnotherMethodOptions) + +Optional custom options to include with the request. + + + +- Returns `Promise`\<`void`\> + +```typescript Example +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#tryanothermethod) + \ 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..9987c6a65 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/OrganizationPicker.mdx @@ -0,0 +1,223 @@ +--- +title: "OrganizationPicker" +--- + +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. + + + +```ts Example +import OrganizationPicker from '@auth0/auth0-acul-js/organization-picker'; + +const organizationPicker = new OrganizationPicker(); +organizationPicker.selectOrganization({ + organization: 'org_XXXXXXXXXXXXXXX' +}); +``` + + +- Extends `BaseContext` + +- Implements [`OrganizationPickerMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationPickerMembers) + +## Constructors + + +{/*> **new OrganizationPicker**(): `OrganizationPicker`*/} + +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. + +- Returns `OrganizationPicker` + +- Overrides `BaseContext.constructor` + + +## Properties + +BrandingMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#branding) + +- Inherited from `BaseContext.branding` + + + +ClientMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#client) + +- Inherited from `BaseContext.client` + + + +OrganizationMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#organization) + +- Inherited from `BaseContext.organization` + + + +PromptMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#prompt) + +- Inherited from `BaseContext.prompt` + + + +ScreenMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#screen) + +- Inherited from `BaseContext.screen` + + + +TenantMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#tenant) + +- Inherited from `BaseContext.tenant` + + + +TransactionMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#transaction) + +- Inherited from `BaseContext.transaction` + + + +UntrustedDataMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#untrusteddata) + +- Inherited from `BaseContext.untrustedData` + + + +UserMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#user) + +- Inherited from `BaseContext.user` + + + + +{/*> `static` **screenIdentifier**: `string` = `ScreenIds.ORGANIZATION_PICKER`*/} + +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 + +- Overrides `BaseContext.screenIdentifier` + + +## Methods + +Error[]}> +{/*> **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/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. + +- 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` + + + + +{/*> **selectOrganization**(`payload`): `Promise`\<`void`\>*/} + +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. + + +SelectOrganizationOptions}> +[`SelectOrganizationOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/SelectOrganizationOptions) + +The ID of the selected organization. `{ organization: string; }` + + + +- Returns `Promise`\<`void`\> + +```typescript Example +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#selectorganization) + + + + +{/*> **skipOrganizationSelection**(`payload?`): `Promise`\<`void`\>*/} + +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. + + +CustomOptions}> +[`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CustomOptions) + +Optional custom options to include with the request. + + + +- Returns `Promise`\<`void`\> + +```typescript Example +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#skiporganizationselection) + \ 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..38d012dfe --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/OrganizationSelection.mdx @@ -0,0 +1,197 @@ +--- +title: "OrganizationSelection" +--- + +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. + + + +```ts Example +import OrganizationSelection from '@auth0/auth0-acul-js/organization-selection'; + +const organizationSelection = new OrganizationSelection(); +await organizationSelection.continueWithOrganizationName({ + organizationName: 'testOrganizationName', +}); +``` + + +- Extends `BaseContext` + +- Implements [`OrganizationSelectionMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationSelectionMembers) + +## Constructors + + +{/*> **new OrganizationSelection**(): `OrganizationSelection`*/} + +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. + +- Returns `OrganizationSelection` + +- Overrides `BaseContext.constructor` + + +## Properties + +BrandingMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#branding) + +- Inherited from `BaseContext.branding` + + + +ClientMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#client) + +- Inherited from `BaseContext.client` + + + +OrganizationMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#organization) + +- Inherited from `BaseContext.organization` + + + +PromptMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#prompt) + +- Inherited from `BaseContext.prompt` + + + +ScreenMembersOnOrganizationSelection}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#screen) + +- Overrides `BaseContext.screen` + + + +TenantMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#tenant) + +- Inherited from `BaseContext.tenant` + + + +TransactionMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#transaction) + +- Inherited from `BaseContext.transaction` + + + +UntrustedDataMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#untrusteddata) + +- Inherited from `BaseContext.untrustedData` + + + +UserMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#user) + +- Inherited from `BaseContext.user` + + + + +{/*> `static` **screenIdentifier**: `string` = `ScreenIds.ORGANIZATION_SELECTION`*/} + +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 + +- Overrides `BaseContext.screenIdentifier` + + +## Methods + + +{/*> **continueWithOrganizationName**(`payload`): `Promise`\<`void`\>*/} + +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. + + +ContinueWithOrganizationNameOptions}> +[`ContinueWithOrganizationNameOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ContinueWithOrganizationNameOptions) + +The options containing the organization name. + + + +- Returns `Promise`\<`void`\> + +```typescript Example +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#continuewithorganizationname) + + + +Error[]}> +{/*> **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/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. + +- 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` + \ 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..3d755fdfc --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/PasskeyEnrollment.mdx @@ -0,0 +1,203 @@ +--- +title: "PasskeyEnrollment" +--- + +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) + + + +```ts Example +import PasskeyEnrollment from '@auth0/auth0-acul-js/passkey-enrollment'; +const passkeyEnrollment = new PasskeyEnrollment(); +passkeyEnrollment.continuePasskeyEnrollment(); +``` + + +- Extends `BaseContext` + +- Implements [`PasskeyEnrollmentMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PasskeyEnrollmentMembers) + +## Constructors + + +{/*> **new PasskeyEnrollment**(): `PasskeyEnrollment`*/} + +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 `PasskeyEnrollment` + +- Overrides `BaseContext.constructor` + + +## Properties + +BrandingMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#branding) + +- Inherited from `BaseContext.branding` + + + +ClientMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#client) + +- Inherited from `BaseContext.client` + + + +OrganizationMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#organization) + +- Inherited from `BaseContext.organization` + + + +PromptMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#prompt) + +- Inherited from `BaseContext.prompt` + + + +ScreenMembersOnPasskeyEnrollment}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#screen) + +- Overrides `BaseContext.screen` + + + +TenantMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#tenant) + +- Inherited from `BaseContext.tenant` + + + +TransactionMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#transaction) + +- Inherited from `BaseContext.transaction` + + + +UntrustedDataMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#untrusteddata) + +- Inherited from `BaseContext.untrustedData` + + + +UserMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#user) + +- Inherited from `BaseContext.user` + + + + +{/*> `static` **screenIdentifier**: `string` = `ScreenIds.PASSKEY_ENROLLMENT`*/} + +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 `BaseContext.screenIdentifier` + + +## Methods + + +{/*> **abortPasskeyEnrollment**(`payload?`): `Promise`\<`void`\>*/} + +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) + + +CustomOptions}> +[`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CustomOptions) + + + +- Returns `Promise`\<`void`\> + +```ts Example +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#abortpasskeyenrollment) + + + + +{/*> **continuePasskeyEnrollment**(`payload?`): `Promise`\<`void`\>*/} + +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) + + +CustomOptions}> +[`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CustomOptions) + + + +- Returns `Promise`\<`void`\> + +```ts Example +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#continuepasskeyenrollment) + + + +Error[]}> +{/*> **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/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. + +- 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` + \ 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..786f0663e --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/PasskeyEnrollmentLocal.mdx @@ -0,0 +1,205 @@ +--- +title: "PasskeyEnrollmentLocal" +--- + +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) + + + +```ts Example +import PasskeyEnrollmentLocal from '@auth0/auth0-acul-js/passkey-enrollment-local'; +const passkeyEnrollment = new PasskeyEnrollmentLocal(); +passkeyEnrollment.continuePasskeyEnrollment(); +``` + + +- Extends `BaseContext` + +- Implements [`PasskeyEnrollmentLocalMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PasskeyEnrollmentLocalMembers) + +## Constructors + + +{/*> **new PasskeyEnrollmentLocal**(): `PasskeyEnrollmentLocal`*/} + +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 `PasskeyEnrollmentLocal` + +- Overrides `BaseContext.constructor` + + +## Properties + +BrandingMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#branding) + +- Inherited from `BaseContext.branding` + + + +ClientMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#client) + +- Inherited from `BaseContext.client` + + + +OrganizationMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#organization) + +- Inherited from `BaseContext.organization` + + + +PromptMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#prompt) + +- Inherited from `BaseContext.prompt` + + + +ScreenMembersOnPasskeyEnrollmentLocal}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#screen) + +- Overrides `BaseContext.screen` + + + +TenantMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#tenant) + +- Inherited from `BaseContext.tenant` + + + +TransactionMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#transaction) + +- Inherited from `BaseContext.transaction` + + + +UntrustedDataMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#untrusteddata) + +- Inherited from `BaseContext.untrustedData` + + + +UserMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#user) + +- Inherited from `BaseContext.user` + + + + +{/*> `static` **screenIdentifier**: `string` = `ScreenIds.PASSKEY_ENROLLMENT_LOCAL`*/} + +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 `BaseContext.screenIdentifier` + + +## Methods + + +{/*> **abortPasskeyEnrollment**(`payload`): `Promise`\<`void`\>*/} + +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) + + +AbortEnrollmentOptions}> +[`AbortEnrollmentOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/AbortEnrollmentOptions) + + + +- Returns `Promise`\<`void`\> + +```ts Example +import PasskeyEnrollmentLocal from '@auth0/auth0-acul-js/passkey-enrollment-local'; + +const passkeyEnrollment = new PasskeyEnrollmentLocal(); +passkeyEnrollment.abortPasskeyEnrollment({ + doNotShowAgain: +}); +``` + +- 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#abortpasskeyenrollment) + + + + +{/*> **continuePasskeyEnrollment**(`payload?`): `Promise`\<`void`\>*/} + +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) + + +CustomOptions}> +[`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CustomOptions) + + + +- Returns `Promise`\<`void`\> + +```ts Example +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#continuepasskeyenrollment) + + + +Error[]}> +{/*> **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/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. + +- 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` + \ 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..83ad484e3 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/PhoneIdentifierChallenge.mdx @@ -0,0 +1,325 @@ +--- +title: "PhoneIdentifierChallenge" +--- + +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) + + + +```ts Example +import PhoneIdentifierChallenge from '@auth0/auth0-acul-js/phone-identifier-challenge'; +const phoneIdentifierChallenge = new PhoneIdentifierChallenge(); +phoneIdentifierChallenge.submitPhoneChallenge({ + code: "" +}); +``` + + +- Extends `BaseContext` + +- Implements [`PhoneIdentifierChallengeMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PhoneIdentifierChallengeMembers) + +## Constructors + + +{/*> **new PhoneIdentifierChallenge**(): `PhoneIdentifierChallenge`*/} + +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 `PhoneIdentifierChallenge` + +- Overrides `BaseContext.constructor` + + +## Properties + +BrandingMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#branding) + +- Inherited from `BaseContext.branding` + + + +ClientMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#client) + +- Inherited from `BaseContext.client` + + + +OrganizationMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#organization) + +- Inherited from `BaseContext.organization` + + + +PromptMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#prompt) + +- Inherited from `BaseContext.prompt` + + + +ScreenMembersOnPhoneIdentifierChallenge}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#screen) + +- Overrides `BaseContext.screen` + + + +TenantMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#tenant) + +- Inherited from `BaseContext.tenant` + + + +TransactionMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#transaction) + +- Inherited from `BaseContext.transaction` + + + +UntrustedDataMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#untrusteddata) + +- Inherited from `BaseContext.untrustedData` + + + +UserMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#user) + +- Inherited from `BaseContext.user` + + + + +{/*> `static` **screenIdentifier**: `string` = `ScreenIds.PHONE_IDENTIFIER_CHALLENGE`*/} + +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 `BaseContext.screenIdentifier` + + +## Methods + +Error[]}> +{/*> **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/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. + +- 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` + + + + +{/*> **resendCode**(`payload?`): `Promise`\<`void`\>*/} + +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) + + +CustomOptions}> +[`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CustomOptions) + + + +- Returns `Promise`\<`void`\> + +```ts Example +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#resendcode) + + + +ResendControl}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/screens/phone-identifier-challenge/index.ts#L136) + +**`Utility Feature`** + +Gets resend functionality with timeout management for this screen + + +StartResendOptions}> +[`StartResendOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/StartResendOptions) + +Configuration options for resend functionality + + + +- Returns [`ResendControl`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResendControl) + +ResendControl object with startResend method + +```ts 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(); +``` + +- 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#resendmanager) + + + + +{/*> **returnToPrevious**(`payload?`): `Promise`\<`void`\>*/} + +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) + + +CustomOptions}> +[`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CustomOptions) + + + +- Returns `Promise`\<`void`\> + +```ts Example +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#returntoprevious) + + + + +{/*> **submitPhoneChallenge**(`payload`): `Promise`\<`void`\>*/} + +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) + + +PhoneChallengeOptions}> +[`PhoneChallengeOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PhoneChallengeOptions) + + + +- Returns `Promise`\<`void`\> + +```ts Example +import PhoneIdentifierChallenge from '@auth0/auth0-acul-js/phone-identifier-challenge'; + +const phoneIdentifierChallenge = new PhoneIdentifierChallenge(); +phoneIdentifierChallenge.submitPhoneChallenge({ + code: "" +}); +``` + +- 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#submitphonechallenge) + + + + +{/*> **switchToText**(`payload?`): `Promise`\<`void`\>*/} + +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) + + +CustomOptions}> +[`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CustomOptions) + + + +- Returns `Promise`\<`void`\> + +```ts Example +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#switchtotext) + + + + +{/*> **switchToVoice**(`payload?`): `Promise`\<`void`\>*/} + +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) + + +CustomOptions}> +[`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CustomOptions) + + + +- Returns `Promise`\<`void`\> + +```ts Example +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#switchtovoice) + \ 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..853b7913e --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/PhoneIdentifierEnrollment.mdx @@ -0,0 +1,207 @@ +--- +title: "PhoneIdentifierEnrollment" +--- + +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) + + + +```ts Example +import PhoneIdentifierEnrollment from '@auth0/auth0-acul-js/phone-identifier-enrollment'; +const phoneIdentifierEnrollment = new PhoneIdentifierEnrollment(); +phoneIdentifierChallenge.continuePhoneEnrollment({ + type: "" +}); +``` + + +- Extends `BaseContext` + +- Implements [`PhoneIdentifierEnrollmentMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PhoneIdentifierEnrollmentMembers) + +## Constructors + + +{/*> **new PhoneIdentifierEnrollment**(): `PhoneIdentifierEnrollment`*/} + +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 `PhoneIdentifierEnrollment` + +- Overrides `BaseContext.constructor` + + +## Properties + +BrandingMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#branding) + +- Inherited from `BaseContext.branding` + + + +ClientMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#client) + +- Inherited from `BaseContext.client` + + + +OrganizationMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#organization) + +- Inherited from `BaseContext.organization` + + + +PromptMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#prompt) + +- Inherited from `BaseContext.prompt` + + + +ScreenMembersOnPhoneIdentifierEnrollment}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#screen) + +- Overrides `BaseContext.screen` + + + +TenantMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#tenant) + +- Inherited from `BaseContext.tenant` + + + +TransactionMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#transaction) + +- Inherited from `BaseContext.transaction` + + + +UntrustedDataMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#untrusteddata) + +- Inherited from `BaseContext.untrustedData` + + + +UserMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#user) + +- Inherited from `BaseContext.user` + + + + +{/*> `static` **screenIdentifier**: `string` = `ScreenIds.PHONE_IDENTIFIER_ENROLLMENT`*/} + +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 `BaseContext.screenIdentifier` + + +## Methods + + +{/*> **continuePhoneEnrollment**(`payload`): `Promise`\<`void`\>*/} + +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) + + +PhoneEnrollmentOptions}> +[`PhoneEnrollmentOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PhoneEnrollmentOptions) + + + +- Returns `Promise`\<`void`\> + +```ts Example +import PhoneIdentifierEnrollment from '@auth0/auth0-acul-js/phone-identifier-enrollment'; + +const phoneIdentifierEnrollment = new PhoneIdentifierEnrollment(); +phoneIdentifierChallenge.continuePhoneEnrollment({ + type: "" +}); +``` + +- 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#continuephoneenrollment) + + + +Error[]}> +{/*> **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/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. + +- 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` + + + + +{/*> **returnToPrevious**(`payload?`): `Promise`\<`void`\>*/} + +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) + + +CustomOptions}> +[`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CustomOptions) + + + +- Returns `Promise`\<`void`\> + +```ts Example +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#returntoprevious) + \ 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..70aff4de2 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/RedeemTicket.mdx @@ -0,0 +1,194 @@ +--- +title: "RedeemTicket" +--- + +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. + + + +```ts Example +import RedeemTicket from '@auth0/auth0-acul-js/redeem-ticket'; + +const redeemTicket = new RedeemTicket(); +await redeemTicket.continue(); +``` + + +- Extends `BaseContext` + +- Implements [`RedeemTicketMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/RedeemTicketMembers) + +## Constructors + + +{/*> **new RedeemTicket**(): `RedeemTicket`*/} + +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. + +- Returns `RedeemTicket` + +- Overrides `BaseContext.constructor` + + +## Properties + +BrandingMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#branding) + +- Inherited from `BaseContext.branding` + + + +ClientMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#client) + +- Inherited from `BaseContext.client` + + + +OrganizationMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#organization) + +- Inherited from `BaseContext.organization` + + + +PromptMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#prompt) + +- Inherited from `BaseContext.prompt` + + + +ScreenMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#screen) + +- Inherited from `BaseContext.screen` + + + +TenantMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#tenant) + +- Inherited from `BaseContext.tenant` + + + +TransactionMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#transaction) + +- Inherited from `BaseContext.transaction` + + + +UntrustedDataMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#untrusteddata) + +- Inherited from `BaseContext.untrustedData` + + + +UserMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#user) + +- Inherited from `BaseContext.user` + + + + +{/*> `static` **screenIdentifier**: `string` = `ScreenIds.REDEEM_TICKET`*/} + +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 `BaseContext.screenIdentifier` + + +## Methods + + +{/*> **continue**(`payload?`): `Promise`\<`void`\>*/} + +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. + + +CustomOptions}> +[`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/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. + +```ts Example +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#continue) + + + +Error[]}> +{/*> **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/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. + +- 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` + \ 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..61df71456 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/ResetPassword.mdx @@ -0,0 +1,206 @@ +--- +title: "ResetPassword" +--- + +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) + + + +```ts 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!', +}); +``` + + +- Extends `BaseContext` + +- Implements [`ResetPasswordMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMembers) + +## Constructors + + +{/*> **new ResetPassword**(): `ResetPassword`*/} + +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 `ResetPassword` + +- Overrides `BaseContext.constructor` + + +## Properties + +BrandingMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#branding) + +- Inherited from `BaseContext.branding` + + + +ClientMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#client) + +- Inherited from `BaseContext.client` + + + +OrganizationMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#organization) + +- Inherited from `BaseContext.organization` + + + +PromptMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#prompt) + +- Inherited from `BaseContext.prompt` + + + +ScreenMembersOnResetPassword}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#screen) + +- Overrides `BaseContext.screen` + + + +TenantMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#tenant) + +- Inherited from `BaseContext.tenant` + + + +TransactionMembersOnResetPassword}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#transaction) + +- Overrides `BaseContext.transaction` + + + +UntrustedDataMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#untrusteddata) + +- Inherited from `BaseContext.untrustedData` + + + +UserMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#user) + +- Inherited from `BaseContext.user` + + + + +{/*> `static` **screenIdentifier**: `string` = `ScreenIds.RESET_PASSWORD`*/} + +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 `BaseContext.screenIdentifier` + + +## Methods + +Error[]}> +{/*> **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/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. + +- 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` + + + + +{/*> **resetPassword**(`payload`): `Promise`\<`void`\>*/} + +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) + + +ResetPasswordOptions}> +[`ResetPasswordOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordOptions) + + + +- Returns `Promise`\<`void`\> + +```ts 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!', +}); +``` + +- 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#resetpassword) + + + +PasswordValidationResult}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/screens/reset-password/index.ts#L55) + +**`Utility Feature`** + + + +`string` + + + +- 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#validatepassword) + \ 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..d4eeb7310 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/ResetPasswordEmail.mdx @@ -0,0 +1,179 @@ +--- +title: "ResetPasswordEmail" +--- + +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) + + + +```ts Example +import ResetPasswordEmail from '@auth0/auth0-acul-js/reset-password-email'; +const resetPasswordEmail = new ResetPasswordEmail(); +resetPasswordEmail.resendEmail(); +``` + + +- Extends `BaseContext` + +- Implements [`ResetPasswordEmailMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordEmailMembers) + +## Constructors + + +{/*> **new ResetPasswordEmail**(): `ResetPasswordEmail`*/} + +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 `ResetPasswordEmail` + +- Overrides `BaseContext.constructor` + + +## Properties + +BrandingMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#branding) + +- Inherited from `BaseContext.branding` + + + +ClientMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#client) + +- Inherited from `BaseContext.client` + + + +OrganizationMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#organization) + +- Inherited from `BaseContext.organization` + + + +PromptMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#prompt) + +- Inherited from `BaseContext.prompt` + + + +ScreenMembersOnResetPasswordEmail}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#screen) + +- Overrides `BaseContext.screen` + + + +TenantMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#tenant) + +- Inherited from `BaseContext.tenant` + + + +TransactionMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#transaction) + +- Inherited from `BaseContext.transaction` + + + +UntrustedDataMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#untrusteddata) + +- Inherited from `BaseContext.untrustedData` + + + +UserMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#user) + +- Inherited from `BaseContext.user` + + + + +{/*> `static` **screenIdentifier**: `string` = `ScreenIds.RESET_PASSWORD_EMAIL`*/} + +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 `BaseContext.screenIdentifier` + + +## Methods + +Error[]}> +{/*> **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/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. + +- 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` + + + + +{/*> **resendEmail**(`payload?`): `Promise`\<`void`\>*/} + +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) + + +CustomOptions}> +[`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CustomOptions) + + + +- Returns `Promise`\<`void`\> + +```ts Example +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#resendemail) + \ 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..248de94f2 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/ResetPasswordError.mdx @@ -0,0 +1,147 @@ +--- +title: "ResetPasswordError" +--- + +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) + + +- Extends `BaseContext` + +- Implements [`ResetPasswordErrorMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordErrorMembers) + +## Constructors + + +{/*> **new ResetPasswordError**(): `ResetPasswordError`*/} + +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 `ResetPasswordError` + +- Overrides `BaseContext.constructor` + + +## Properties + +BrandingMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#branding) + +- Inherited from `BaseContext.branding` + + + +ClientMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#client) + +- Inherited from `BaseContext.client` + + + +OrganizationMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#organization) + +- Inherited from `BaseContext.organization` + + + +PromptMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#prompt) + +- Inherited from `BaseContext.prompt` + + + +ScreenMembersOnResetPasswordError}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#screen) + +- Overrides `BaseContext.screen` + + + +TenantMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#tenant) + +- Inherited from `BaseContext.tenant` + + + +TransactionMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#transaction) + +- Inherited from `BaseContext.transaction` + + + +UntrustedDataMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#untrusteddata) + +- Inherited from `BaseContext.untrustedData` + + + +UserMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#user) + +- Inherited from `BaseContext.user` + + + + +{/*> `static` **screenIdentifier**: `string` = `ScreenIds.RESET_PASSWORD_ERROR`*/} + +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 `BaseContext.screenIdentifier` + + +## Methods + +Error[]}> +{/*> **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/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. + +- 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` + \ 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..2253a7c45 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/ResetPasswordMfaEmailChallenge.mdx @@ -0,0 +1,291 @@ +--- +title: "ResetPasswordMfaEmailChallenge" +--- + +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 + + + +```ts Example +import ResetPasswordMfaEmailChallenge from '@auth0/auth0-acul-js/reset-password-mfa-email-challenge'; + +const resetPasswordMfaEmailChallenge = new ResetPasswordMfaEmailChallenge(); +await resetPasswordMfaEmailChallenge.continue({ + code: '123456', +}); +``` + + +- Extends `BaseContext` + +- Implements [`ResetPasswordMfaEmailChallengeMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMfaEmailChallengeMembers) + +## Constructors + + +{/*> **new ResetPasswordMfaEmailChallenge**(): `ResetPasswordMfaEmailChallenge`*/} + +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 + +- Returns `ResetPasswordMfaEmailChallenge` + +- Overrides `BaseContext.constructor` + + +## Properties + +BrandingMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#branding) + +- Inherited from `BaseContext.branding` + + + +ClientMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#client) + +- Inherited from `BaseContext.client` + + + +OrganizationMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#organization) + +- Inherited from `BaseContext.organization` + + + +PromptMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#prompt) + +- Inherited from `BaseContext.prompt` + + + +ScreenMembersOnResetPasswordMfaEmailChallenge}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#screen) + +- Overrides `BaseContext.screen` + + + +TenantMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#tenant) + +- Inherited from `BaseContext.tenant` + + + +TransactionMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#transaction) + +- Inherited from `BaseContext.transaction` + + + +UntrustedDataMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#untrusteddata) + +- Inherited from `BaseContext.untrustedData` + + + +UserMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#user) + +- Inherited from `BaseContext.user` + + + + +{/*> `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/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/screens/reset-password-mfa-email-challenge/index.ts#L24) + +- Overrides `BaseContext.screenIdentifier` + + +## Methods + + +{/*> **continue**(`payload`): `Promise`\<`void`\>*/} + +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. + + +ContinueOptions}> +[`ContinueOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ContinueOptions) + +The options containing the code and rememberDevice flag. + + + +- Returns `Promise`\<`void`\> + +```typescript Example +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#continue) + + + +Error[]}> +{/*> **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/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. + +- 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` + + + + +{/*> **resendCode**(`payload?`): `Promise`\<`void`\>*/} + +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. + + +ResendCodeOptions}> +[`ResendCodeOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResendCodeOptions) + +Optional custom options to include with the request. + + + +- Returns `Promise`\<`void`\> + +```typescript Example +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#resendcode) + + + +ResendControl}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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 + + +StartResendOptions}> +[`StartResendOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/StartResendOptions) + +Configuration options for resend functionality + + + +- Returns [`ResendControl`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResendControl) + +ResendControl object with startResend method + +```typescript Example +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#resendmanager) + + + + +{/*> **tryAnotherMethod**(`payload?`): `Promise`\<`void`\>*/} + +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. + + +TryAnotherMethodOptions}> +[`TryAnotherMethodOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TryAnotherMethodOptions) + +Optional custom options to include with the request. + + + +- Returns `Promise`\<`void`\> + +```typescript Example +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#tryanothermethod) + \ 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..ea22fba9e --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/ResetPasswordMfaOtpChallenge.mdx @@ -0,0 +1,222 @@ +--- +title: "ResetPasswordMfaOtpChallenge" +--- + +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 + + + +```ts Example +import ResetPasswordMfaOtpChallenge from '@auth0/auth0-acul-js/reset-password-mfa-otp-challenge'; + +const resetPasswordMfaOtpChallenge = new ResetPasswordMfaOtpChallenge(); +await resetPasswordMfaOtpChallenge.continue({ + code: '123456', +}); +``` + + +- Extends `BaseContext` + +- Implements [`ResetPasswordMfaOtpChallengeMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMfaOtpChallengeMembers) + +## Constructors + + +{/*> **new ResetPasswordMfaOtpChallenge**(): `ResetPasswordMfaOtpChallenge`*/} + +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 + +- Returns `ResetPasswordMfaOtpChallenge` + +- Overrides `BaseContext.constructor` + + +## Properties + +BrandingMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#branding) + +- Inherited from `BaseContext.branding` + + + +ClientMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#client) + +- Inherited from `BaseContext.client` + + + +OrganizationMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#organization) + +- Inherited from `BaseContext.organization` + + + +PromptMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#prompt) + +- Inherited from `BaseContext.prompt` + + + +ScreenMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#screen) + +- Inherited from `BaseContext.screen` + + + +TenantMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#tenant) + +- Inherited from `BaseContext.tenant` + + + +TransactionMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#transaction) + +- Inherited from `BaseContext.transaction` + + + +UntrustedDataMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#untrusteddata) + +- Inherited from `BaseContext.untrustedData` + + + +UserMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#user) + +- Inherited from `BaseContext.user` + + + + +{/*> `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/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/screens/reset-password-mfa-otp-challenge/index.ts#L20) + +Screen identifier for validation and telemetry + +- Overrides `BaseContext.screenIdentifier` + + +## Methods + + +{/*> **continue**(`payload`): `Promise`\<`void`\>*/} + +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. + + +ResetPasswordMfaOtpChallengeContinueOptions}> +[`ResetPasswordMfaOtpChallengeContinueOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMfaOtpChallengeContinueOptions) + +The options containing the code. + + + +- Returns `Promise`\<`void`\> + +```typescript Example +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#continue) + + + +Error[]}> +{/*> **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/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. + +- 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` + + + + +{/*> **tryAnotherMethod**(`payload?`): `Promise`\<`void`\>*/} + +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. + + +ResetPasswordMfaOtpChallengeTryAnotherMethodOptions}> +[`ResetPasswordMfaOtpChallengeTryAnotherMethodOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMfaOtpChallengeTryAnotherMethodOptions) + +Optional custom options to include with the request. + + + +- Returns `Promise`\<`void`\> + +```typescript Example +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#tryanothermethod) + \ 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..d520c3336 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/ResetPasswordMfaPhoneChallenge.mdx @@ -0,0 +1,257 @@ +--- +title: "ResetPasswordMfaPhoneChallenge" +--- + +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 + + + +```ts Example +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); +} +``` + + +- Extends `BaseContext` + +- Implements [`ResetPasswordMfaPhoneChallengeMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMfaPhoneChallengeMembers) + +## Constructors + + +{/*> **new ResetPasswordMfaPhoneChallenge**(): `ResetPasswordMfaPhoneChallenge`*/} + +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. + +- Returns `ResetPasswordMfaPhoneChallenge` + +#### Throws + +If the Universal Login Context is not available or if the screen name doesn't match. + +- Overrides `BaseContext.constructor` + + +## Properties + +BrandingMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#branding) + +- Inherited from `BaseContext.branding` + + + +ClientMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#client) + +- Inherited from `BaseContext.client` + + + +OrganizationMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#organization) + +- Inherited from `BaseContext.organization` + + + +PromptMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#prompt) + +- Inherited from `BaseContext.prompt` + + + +ScreenMembersOnResetPasswordMfaPhoneChallenge}> +{/*> **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/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. + +- 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#screen) + +- Overrides `BaseContext.screen` + + + +TenantMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#tenant) + +- Inherited from `BaseContext.tenant` + + + +TransactionMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#transaction) + +- Inherited from `BaseContext.transaction` + + + +UntrustedDataMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#untrusteddata) + +- Inherited from `BaseContext.untrustedData` + + + +UserMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#user) + +- Inherited from `BaseContext.user` + + + + +{/*> `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/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. + +- Overrides `BaseContext.screenIdentifier` + + +## Methods + + +{/*> **continue**(`payload`): `Promise`\<`void`\>*/} + +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'). + + +ResetPasswordMfaPhoneChallengeContinueOptions}> +[`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. + + + +- Returns `Promise`\<`void`\> + +A promise resolving upon successful submission to the server. + +#### Throws + +If the form submission fails. + +```typescript Example +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#continue) + + + +Error[]}> +{/*> **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/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. + +- 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` + + + + +{/*> **tryAnotherMethod**(`payload`): `Promise`\<`void`\>*/} + +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'). + + +ResetPasswordMfaPhoneChallengeTryAnotherMethodOptions}> +[`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. + + + +- Returns `Promise`\<`void`\> + +A promise resolving upon successful submission to the server. + +#### Throws + +If the form submission fails. + +```typescript Example +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#tryanothermethod) + \ 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..5c40581cc --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/ResetPasswordMfaPushChallengePush.mdx @@ -0,0 +1,329 @@ +--- +title: "ResetPasswordMfaPushChallengePush" +--- + +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 + + + +```ts Example +import ResetPasswordMfaPushChallengePush from '@auth0/auth0-acul-js/reset-password-mfa-push-challenge-push'; + +const resetPasswordMfaPushChallengePush = new ResetPasswordMfaPushChallengePush(); +await resetPasswordMfaPushChallengePush.continue(); +``` + + +- Extends `BaseContext` + +- Implements [`ResetPasswordMfaPushChallengePushMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMfaPushChallengePushMembers) + +## Constructors + + +{/*> **new ResetPasswordMfaPushChallengePush**(): `ResetPasswordMfaPushChallengePush`*/} + +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 `ResetPasswordMfaPushChallengePush` + +- Overrides `BaseContext.constructor` + + +## Properties + +BrandingMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#branding) + +- Inherited from `BaseContext.branding` + + + +ClientMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#client) + +- Inherited from `BaseContext.client` + + + +OrganizationMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#organization) + +- Inherited from `BaseContext.organization` + + + +PromptMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#prompt) + +- Inherited from `BaseContext.prompt` + + + +ScreenMembersOnResetPasswordMfaPushChallengePush}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#screen) + +- Overrides `BaseContext.screen` + + + +TenantMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#tenant) + +- Inherited from `BaseContext.tenant` + + + +TransactionMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#transaction) + +- Inherited from `BaseContext.transaction` + + + +UntrustedDataMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#untrusteddata) + +- Inherited from `BaseContext.untrustedData` + + + +UserMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#user) + +- Inherited from `BaseContext.user` + + + + +{/*> `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/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/screens/reset-password-mfa-push-challenge-push/index.ts#L22) + +- Overrides `BaseContext.screenIdentifier` + + +## Methods + + +{/*> **continue**(`payload?`): `Promise`\<`void`\>*/} + +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 + + +CustomOptions}> +[`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CustomOptions) + +Optional custom options to include with the request + + + +- Returns `Promise`\<`void`\> + +```typescript Example +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#continue) + + + + +{/*> **enterCodeManually**(`payload?`): `Promise`\<`void`\>*/} + +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 + + +CustomOptions}> +[`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CustomOptions) + +Optional custom options to include with the request + + + +- Returns `Promise`\<`void`\> + +```typescript Example +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#entercodemanually) + + + +Error[]}> +{/*> **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/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. + +- 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` + + + +MfaPushPollingControl}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#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. + + +MfaPollingOptions}> +[`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). + + + +- 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. + +```ts Example +// 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#pollingmanager) + + + + +{/*> **resendPushNotification**(`payload?`): `Promise`\<`void`\>*/} + +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 + + +CustomOptions}> +[`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CustomOptions) + +Optional custom options to include with the request + + + +- Returns `Promise`\<`void`\> + +```typescript Example +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#resendpushnotification) + + + + +{/*> **tryAnotherMethod**(`payload?`): `Promise`\<`void`\>*/} + +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 + + +CustomOptions}> +[`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CustomOptions) + +Optional custom options to include with the request + + + +- Returns `Promise`\<`void`\> + +```typescript Example +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#tryanothermethod) + \ 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..43341e40a --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/ResetPasswordMfaRecoveryCodeChallenge.mdx @@ -0,0 +1,238 @@ +--- +title: "ResetPasswordMfaRecoveryCodeChallenge" +--- + +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. + + + +```ts Example +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); + } +}; +``` + + +- Extends `BaseContext` + +- Implements [`ResetPasswordMfaRecoveryCodeChallengeMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMfaRecoveryCodeChallengeMembers) + +## Constructors + + +{/*> **new ResetPasswordMfaRecoveryCodeChallenge**(): `ResetPasswordMfaRecoveryCodeChallenge`*/} + +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. + +- Returns `ResetPasswordMfaRecoveryCodeChallenge` + +- Overrides `BaseContext.constructor` + + +## Properties + +BrandingMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#branding) + +- Inherited from `BaseContext.branding` + + + +ClientMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#client) + +- Inherited from `BaseContext.client` + + + +OrganizationMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#organization) + +- Inherited from `BaseContext.organization` + + + +PromptMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#prompt) + +- Inherited from `BaseContext.prompt` + + + +ScreenMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#screen) + +- Inherited from `BaseContext.screen` + + + +TenantMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#tenant) + +- Inherited from `BaseContext.tenant` + + + +TransactionMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#transaction) + +- Inherited from `BaseContext.transaction` + + + +UntrustedDataMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#untrusteddata) + +- Inherited from `BaseContext.untrustedData` + + + +UserMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#user) + +- Inherited from `BaseContext.user` + + + + +{/*> `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/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/screens/reset-password-mfa-recovery-code-challenge/index.ts#L13) + +- Overrides `BaseContext.screenIdentifier` + + +## Methods + + +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/screens/reset-password-mfa-recovery-code-challenge/index.ts#L41) + +Continues with the provided recovery code. + + + +`string` + +The recovery code entered by the user. + +CustomOptions}> +[`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CustomOptions) + +Optional payload. + + + +- Returns `Promise`\<`void`\> + +```typescript Example +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#continue) + + + +Error[]}> +{/*> **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/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. + +- 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` + + + + +{/*> **tryAnotherMethod**(`payload?`): `Promise`\<`void`\>*/} + +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. + + +CustomOptions}> +[`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CustomOptions) + +Optional payload. + + + +- Returns `Promise`\<`void`\> + +```typescript Example +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#tryanothermethod) + \ 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..1de3e4647 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/ResetPasswordMfaSmsChallenge.mdx @@ -0,0 +1,317 @@ +--- +title: "ResetPasswordMfaSmsChallenge" +--- + +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. + + + +```ts Example +import ResetPasswordMfaSmsChallenge from '@auth0/auth0-acul-js/reset-password-mfa-sms-challenge'; + +const resetPasswordMfaSmsChallenge = new ResetPasswordMfaSmsChallenge(); +await resetPasswordMfaSmsChallenge.continueMfaSmsChallenge({ + code: '123456', +}); +``` + + +- Extends `BaseContext` + +- Implements [`ResetPasswordMfaSmsChallengeMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMfaSmsChallengeMembers) + +## Constructors + + +{/*> **new ResetPasswordMfaSmsChallenge**(): `ResetPasswordMfaSmsChallenge`*/} + +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 `ResetPasswordMfaSmsChallenge` + +- Overrides `BaseContext.constructor` + + +## Properties + +BrandingMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#branding) + +- Inherited from `BaseContext.branding` + + + +ClientMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#client) + +- Inherited from `BaseContext.client` + + + +OrganizationMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#organization) + +- Inherited from `BaseContext.organization` + + + +PromptMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#prompt) + +- Inherited from `BaseContext.prompt` + + + +ScreenMembersOnResetPasswordMfaSmsChallenge}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#screen) + +- Overrides `BaseContext.screen` + + + +TenantMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#tenant) + +- Inherited from `BaseContext.tenant` + + + +TransactionMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#transaction) + +- Inherited from `BaseContext.transaction` + + + +UntrustedDataMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#untrusteddata) + +- Inherited from `BaseContext.untrustedData` + + + +UserMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#user) + +- Inherited from `BaseContext.user` + + + + +{/*> `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/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/screens/reset-password-mfa-sms-challenge/index.ts#L23) + +- Overrides `BaseContext.screenIdentifier` + + +## Methods + + +{/*> **continueMfaSmsChallenge**(`payload`): `Promise`\<`void`\>*/} + +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. + + +ResetPasswordMfaSmsChallengeOptions}> +[`ResetPasswordMfaSmsChallengeOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMfaSmsChallengeOptions) + +The payload containing the code. + + + +- Returns `Promise`\<`void`\> + +```typescript Example +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#continuemfasmschallenge) + + + + +{/*> **getACall**(`payload?`): `Promise`\<`void`\>*/} + +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. + + +CustomOptions}> +[`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CustomOptions) + +Optional payload. + + + +- Returns `Promise`\<`void`\> + +```typescript Example +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#getacall) + + + +Error[]}> +{/*> **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/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. + +- 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` + + + + +{/*> **resendCode**(`payload?`): `Promise`\<`void`\>*/} + +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. + + +CustomOptions}> +[`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CustomOptions) + +Optional payload. + + + +- Returns `Promise`\<`void`\> + +```typescript Example +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#resendcode) + + + +ResendControl}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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 + + +StartResendOptions}> +[`StartResendOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/StartResendOptions) + +Configuration options for resend functionality + + + +- Returns [`ResendControl`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResendControl) + +ResendControl object with startResend method + +```typescript Example +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#resendmanager) + + + + +{/*> **tryAnotherMethod**(`payload?`): `Promise`\<`void`\>*/} + +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. + + +CustomOptions}> +[`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CustomOptions) + +Optional payload. + + + +- Returns `Promise`\<`void`\> + +```typescript Example +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#tryanothermethod) + \ 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..93f04cecf --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/ResetPasswordMfaVoiceChallenge.mdx @@ -0,0 +1,298 @@ +--- +title: "ResetPasswordMfaVoiceChallenge" +--- + +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. + + + +```ts Example +const reset = new ResetPasswordMfaVoiceChallenge(); +await reset.continue({ code: '123456' }); +``` + + +- Extends `BaseContext` + +- Implements [`ResetPasswordMfaVoiceChallengeMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMfaVoiceChallengeMembers) + +## Constructors + + +{/*> **new ResetPasswordMfaVoiceChallenge**(): `ResetPasswordMfaVoiceChallenge`*/} + +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. + +- Returns `ResetPasswordMfaVoiceChallenge` + +- Overrides `BaseContext.constructor` + + +## Properties + +BrandingMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#branding) + +- Inherited from `BaseContext.branding` + + + +ClientMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#client) + +- Inherited from `BaseContext.client` + + + +OrganizationMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#organization) + +- Inherited from `BaseContext.organization` + + + +PromptMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#prompt) + +- Inherited from `BaseContext.prompt` + + + +ScreenMembersOnResetPasswordMfaVoiceChallenge}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#screen) + +- Overrides `BaseContext.screen` + + + +TenantMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#tenant) + +- Inherited from `BaseContext.tenant` + + + +TransactionMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#transaction) + +- Inherited from `BaseContext.transaction` + + + +UntrustedDataMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#untrusteddata) + +- Inherited from `BaseContext.untrustedData` + + + +UserMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#user) + +- Inherited from `BaseContext.user` + + + + +{/*> `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/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/screens/reset-password-mfa-voice-challenge/index.ts#L26) + +- Overrides `BaseContext.screenIdentifier` + + +## Methods + + +{/*> **continue**(`payload`): `Promise`\<`void`\>*/} + +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. + + +ResetPasswordMfaVoiceChallengeContinueOptions}> +[`ResetPasswordMfaVoiceChallengeContinueOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMfaVoiceChallengeContinueOptions) + +The options containing the code. + + + +- Returns `Promise`\<`void`\> + +A promise that resolves when the challenge is submitted. + +```ts Example +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#continue) + + + +Error[]}> +{/*> **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/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. + +- 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` + + + + +{/*> **resendCode**(`payload?`): `Promise`\<`void`\>*/} + +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. + + +CustomOptions}> +[`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CustomOptions) + +Optional custom options to include with the request. + + + +- 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#resendcode) + + + +ResendControl}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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 + + +StartResendOptions}> +[`StartResendOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/StartResendOptions) + +Configuration options for resend functionality + + + +- Returns [`ResendControl`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResendControl) + +ResendControl object with startResend method + +```typescript Example +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#resendmanager) + + + + +{/*> **switchToSms**(`payload?`): `Promise`\<`void`\>*/} + +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. + + +CustomOptions}> +[`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CustomOptions) + +Optional custom options to include with the request. + + + +- 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#switchtosms) + + + + +{/*> **tryAnotherMethod**(`payload?`): `Promise`\<`void`\>*/} + +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. + + +CustomOptions}> +[`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CustomOptions) + +Optional custom options to include with the request. + + + +- 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#tryanothermethod) + \ 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..4e7d68011 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/ResetPasswordMfaWebAuthnPlatformChallenge.mdx @@ -0,0 +1,317 @@ +--- +title: "ResetPasswordMfaWebAuthnPlatformChallenge" +--- + +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 + + + +```ts Example +// 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. +} +``` + + +- Extends `BaseContext` + +- Implements [`ResetPasswordMfaWebAuthnPlatformChallengeMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMfaWebAuthnPlatformChallengeMembers) + +## Constructors + + +{/*> **new ResetPasswordMfaWebAuthnPlatformChallenge**(): `ResetPasswordMfaWebAuthnPlatformChallenge`*/} + +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` +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` + + +## Properties + +BrandingMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#branding) + +- Inherited from `BaseContext.branding` + + + +ClientMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#client) + +- Inherited from `BaseContext.client` + + + +OrganizationMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#organization) + +- Inherited from `BaseContext.organization` + + + +PromptMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#prompt) + +- Inherited from `BaseContext.prompt` + + + +ScreenMembersOnResetPasswordMfaWebAuthnPlatformChallenge}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#screen) + +- Overrides `BaseContext.screen` + + + +TenantMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#tenant) + +- Inherited from `BaseContext.tenant` + + + +TransactionMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#transaction) + +- Inherited from `BaseContext.transaction` + + + +UntrustedDataMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#untrusteddata) + +- Inherited from `BaseContext.untrustedData` + + + +UserMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#user) + +- Inherited from `BaseContext.user` + + + + +{/*> `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/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/screens/reset-password-mfa-webauthn-platform-challenge/index.ts#L47) + +static + +- Overrides `BaseContext.screenIdentifier` + + +## Methods + + +{/*> **continueWithPasskey**(`options?`): `Promise`\<`void`\>*/} + +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`. +If successful, it submits the resulting credential assertion to Auth0 with `action: "default"`. + + +ResetPasswordMfaWebAuthnPlatformChallengeContinueOptions}> +[`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. + + + +- 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`. + +```typescript Example +// 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#continuewithpasskey) + + + +Error[]}> +{/*> **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/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. + +- 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` + + + + +{/*> **reportBrowserError**(`options`): `Promise`\<`void`\>*/} + +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`), +timeout, or other WebAuthn API specific errors. +It submits the error details with `action: "showError::{errorDetailsJsonString}"`. + + +ResetPasswordMfaWebAuthnPlatformChallengeReportErrorOptions}> +[`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. + + + +- 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). + +```typescript Example +// 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#reportbrowsererror) + + + + +{/*> **tryAnotherMethod**(`options?`): `Promise`\<`void`\>*/} + +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. +This action submits `action: "pick-authenticator"` to Auth0, which should navigate +the user to an MFA factor selection screen. + + +ResetPasswordMfaWebAuthnPlatformChallengeTryAnotherMethodOptions}> +[`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. + + + +- 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). + +```typescript Example +// 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#tryanothermethod) + \ 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..f193f7fe1 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/ResetPasswordMfaWebAuthnRoamingChallenge.mdx @@ -0,0 +1,333 @@ +--- +title: "ResetPasswordMfaWebAuthnRoamingChallenge" +--- + +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 + + + +```ts Example +// 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. + } +} +``` + + +- Extends `BaseContext` + +- Implements [`ResetPasswordMfaWebAuthnRoamingChallengeMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMfaWebAuthnRoamingChallengeMembers) + +## Constructors + + +{/*> **new ResetPasswordMfaWebAuthnRoamingChallenge**(): `ResetPasswordMfaWebAuthnRoamingChallenge`*/} + +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 + +- 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` + + +## Properties + +BrandingMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#branding) + +- Inherited from `BaseContext.branding` + + + +ClientMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#client) + +- Inherited from `BaseContext.client` + + + +OrganizationMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#organization) + +- Inherited from `BaseContext.organization` + + + +PromptMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#prompt) + +- Inherited from `BaseContext.prompt` + + + +ScreenMembersOnResetPasswordMfaWebAuthnRoamingChallenge}> +{/*> **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/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, + +(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#screen) + +- Overrides `BaseContext.screen` + + + +TenantMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#tenant) + +- Inherited from `BaseContext.tenant` + + + +TransactionMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#transaction) + +- Inherited from `BaseContext.transaction` + + + +UntrustedDataMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#untrusteddata) + +- Inherited from `BaseContext.untrustedData` + + + +UserMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#user) + +- Inherited from `BaseContext.user` + + + + +{/*> `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/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. + +- Overrides `BaseContext.screenIdentifier` + + +## Methods + +Error[]}> +{/*> **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/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. + +- 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` + + + + +{/*> **showError**(`options`): `Promise`\<`void`\>*/} + +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 +`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`. + + +ResetPasswordMfaWebAuthnRoamingChallengeShowErrorOptions}> +[`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. + + + +- 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). + +```typescript Example +// 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#showerror) + + + + +{/*> **tryAnotherMethod**(`options?`): `Promise`\<`void`\>*/} + +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 +the user to an MFA factor selection screen. + + +ResetPasswordMfaWebAuthnRoamingChallengeTryAnotherMethodOptions}> +[`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. + + + +- 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). + +```typescript Example +// 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#tryanothermethod) + + + + +{/*> **useSecurityKey**(`options?`): `Promise`\<`void`\>*/} + +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 +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"`. + + +ResetPasswordMfaWebAuthnRoamingChallengeUseSecurityKeyOptions}> +[`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. + + + +- 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). + +```typescript Example +// 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#usesecuritykey) + \ 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..f6ed606fc --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/ResetPasswordRequest.mdx @@ -0,0 +1,226 @@ +--- +title: "ResetPasswordRequest" +--- + +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) + + + +```ts Example +import ResetPasswordRequest from "@auth0/auth0-acul-js/reset-password-request"; +const resetPasswordRequest = new ResetPasswordRequest(); +resetPasswordRequest.getLoginIdentifiers(); +``` + + +- Extends `BaseContext` + +- Implements [`ResetPasswordRequestMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordRequestMembers) + +## Constructors + + +{/*> **new ResetPasswordRequest**(): `ResetPasswordRequest`*/} + +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 `ResetPasswordRequest` + +- Overrides `BaseContext.constructor` + + +## Properties + +BrandingMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#branding) + +- Inherited from `BaseContext.branding` + + + +ClientMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#client) + +- Inherited from `BaseContext.client` + + + +OrganizationMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#organization) + +- Inherited from `BaseContext.organization` + + + +PromptMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#prompt) + +- Inherited from `BaseContext.prompt` + + + +ScreenMembersOnResetPasswordRequest}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#screen) + +- Overrides `BaseContext.screen` + + + +TenantMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#tenant) + +- Inherited from `BaseContext.tenant` + + + +TransactionMembersOnResetPasswordRequest}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#transaction) + +- Overrides `BaseContext.transaction` + + + +UntrustedDataMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#untrusteddata) + +- Inherited from `BaseContext.untrustedData` + + + +UserMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#user) + +- Inherited from `BaseContext.user` + + + + +{/*> `static` **screenIdentifier**: `string` = `ScreenIds.RESET_PASSWORD_REQUEST`*/} + +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 `BaseContext.screenIdentifier` + + +## Methods + + +{/*> **backToLogin**(`payload?`): `Promise`\<`void`\>*/} + +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) + + +CustomOptions}> +[`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CustomOptions) + + + +- Returns `Promise`\<`void`\> + +```ts Example +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#backtologin) + + + +Error[]}> +{/*> **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/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. + +- 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` + + + +ScreenIdentifierType[]}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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 + +```typescript Example +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#getloginidentifiers) + + + + +{/*> **resetPassword**(`payload`): `Promise`\<`void`\>*/} + +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) + + +ResetPasswordRequestOptions}> +[`ResetPasswordRequestOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordRequestOptions) + + + +- Returns `Promise`\<`void`\> + +```ts Example +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#resetpassword) + \ 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..48f793c0a --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/ResetPasswordSuccess.mdx @@ -0,0 +1,147 @@ +--- +title: "ResetPasswordSuccess" +--- + +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) + + +- Extends `BaseContext` + +- Implements [`ResetPasswordSuccessMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordSuccessMembers) + +## Constructors + + +{/*> **new ResetPasswordSuccess**(): `ResetPasswordSuccess`*/} + +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 `ResetPasswordSuccess` + +- Overrides `BaseContext.constructor` + + +## Properties + +BrandingMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#branding) + +- Inherited from `BaseContext.branding` + + + +ClientMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#client) + +- Inherited from `BaseContext.client` + + + +OrganizationMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#organization) + +- Inherited from `BaseContext.organization` + + + +PromptMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#prompt) + +- Inherited from `BaseContext.prompt` + + + +ScreenMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#screen) + +- Inherited from `BaseContext.screen` + + + +TenantMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#tenant) + +- Inherited from `BaseContext.tenant` + + + +TransactionMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#transaction) + +- Inherited from `BaseContext.transaction` + + + +UntrustedDataMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#untrusteddata) + +- Inherited from `BaseContext.untrustedData` + + + +UserMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#user) + +- Inherited from `BaseContext.user` + + + + +{/*> `static` **screenIdentifier**: `string` = `ScreenIds.RESET_PASSWORD_SUCCESS`*/} + +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 `BaseContext.screenIdentifier` + + +## Methods + +Error[]}> +{/*> **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/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. + +- 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` + \ 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..4459f94ba --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/SDKUsageError.mdx @@ -0,0 +1,48 @@ +--- +title: "SDKUsageError" +--- + +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 + +- Extends [`AculError`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/AculError) + +## Constructors + + +{/*> **new SDKUsageError**(`message`, `field?`): `SDKUsageError`*/} + +Defined in: [src/utils/errors.ts:49](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/utils/errors.ts#L49) + + + +The error message. + + +The optional field associated with the error. + + +- 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#constructor) + + +## Properties + + +{/*> `readonly` **code**: `"SDK_USAGE_ERROR"` = `'SDK_USAGE_ERROR'`*/} + +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 [`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#code) + + + + +{/*> `readonly` `optional` **field**: `string`*/} + +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 [`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#field) + \ 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..d56b6db4f --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/Signup.mdx @@ -0,0 +1,322 @@ +--- +title: "Signup" +--- + +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) + + + +```ts Example +import Signup from '@auth0/auth0-acul-js/signup'; + +const signupManager = new Signup(); + +signupManager.signup({ + email: 'test@example.com', + password: 'P@$wOrd123!', +}); +``` + + +- Extends `BaseContext` + +- Implements [`SignupMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/SignupMembers) + +## Constructors + + +{/*> **new Signup**(): `Signup`*/} + +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 `Signup` + +- Overrides `BaseContext.constructor` + + +## Properties + +BrandingMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#branding) + +- Inherited from `BaseContext.branding` + + + +ClientMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#client) + +- Inherited from `BaseContext.client` + + + +OrganizationMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#organization) + +- Inherited from `BaseContext.organization` + + + +PromptMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#prompt) + +- Inherited from `BaseContext.prompt` + + + +ScreenMembersOnSignup}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#screen) + +- Overrides `BaseContext.screen` + + + +TenantMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#tenant) + +- Inherited from `BaseContext.tenant` + + + +TransactionMembersOnSignup}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#transaction) + +- Overrides `BaseContext.transaction` + + + +UntrustedDataMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#untrusteddata) + +- Inherited from `BaseContext.untrustedData` + + + +UserMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#user) + +- Inherited from `BaseContext.user` + + + + +{/*> `static` **screenIdentifier**: `string` = `ScreenIds.SIGNUP`*/} + +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 `BaseContext.screenIdentifier` + + +## Methods + + +{/*> **federatedSignup**(`payload`): `Promise`\<`void`\>*/} + +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. + + +FederatedSignupPayloadOptions}> +[`FederatedSignupPayloadOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/FederatedSignupPayloadOptions) + +The payload containing the social signup options. + + + +- Returns `Promise`\<`void`\> + +#### Remarks + +This method is similar to the [signup](#signup) method but is used for social signups. + +```typescript Example +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#federatedsignup) + + + +Error[]}> +{/*> **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/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. + +- 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` + + + +Identifier[]}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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). + +```ts Example +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#getsignupidentifiers) + + + + +{/*> **pickCountryCode**(): `Promise`\<`void`\>*/} + +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 `Promise`\<`void`\> + +```ts Example +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#pickcountrycode) + + + + +{/*> **signup**(`payload`): `Promise`\<`void`\>*/} + +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) + + +SignupPayloadOptions}> +[`SignupPayloadOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/SignupPayloadOptions) + + + +- Returns `Promise`\<`void`\> + +#### Remarks + +This method handles the submission of the signup form. + +```typescript Example +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#signup) + + + +PasswordValidationResult}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/screens/signup/index.ts#L113) + +**`Utility Feature`** + + + +`string` + + + +- 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#validatepassword) + + + +UsernameValidationResult}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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. + + + +`string` + +The username string to validate. + + + +- Returns [`UsernameValidationResult`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UsernameValidationResult) + +Result object indicating whether the username is valid and why. + +```ts Example +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#validateusername) + \ 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..7d42e5a1d --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/SignupId.mdx @@ -0,0 +1,315 @@ +--- +title: "SignupId" +--- + +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) + + + +```ts 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); +``` + + +- Extends `BaseContext` + +- Implements [`SignupIdMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/SignupIdMembers) + +## Constructors + + +{/*> **new SignupId**(): `SignupId`*/} + +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 `SignupId` + +- Overrides `BaseContext.constructor` + + +## Properties + +BrandingMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#branding) + +- Inherited from `BaseContext.branding` + + + +ClientMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#client) + +- Inherited from `BaseContext.client` + + + +OrganizationMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#organization) + +- Inherited from `BaseContext.organization` + + + +PromptMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#prompt) + +- Inherited from `BaseContext.prompt` + + + +ScreenMembersOnSignupId}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#screen) + +- Overrides `BaseContext.screen` + + + +TenantMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#tenant) + +- Inherited from `BaseContext.tenant` + + + +TransactionMembersOnSignupId}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#transaction) + +- Overrides `BaseContext.transaction` + + + +UntrustedDataMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#untrusteddata) + +- Inherited from `BaseContext.untrustedData` + + + +UserMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#user) + +- Inherited from `BaseContext.user` + + + + +{/*> `static` **screenIdentifier**: `string` = `ScreenIds.SIGNUP_ID`*/} + +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 `BaseContext.screenIdentifier` + + +## Methods + + +{/*> **federatedSignup**(`payload`): `Promise`\<`void`\>*/} + +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) + + +FederatedSignupOptions}> +[`FederatedSignupOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/FederatedSignupOptions) + + + +- Returns `Promise`\<`void`\> + +#### Remarks + +This methods handles allows signup via different social identifiers. +Eg: Google, Facebook etc. + +```ts 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); +``` + +- 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#federatedsignup) + + + +Error[]}> +{/*> **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/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. + +- 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` + + + +Identifier[]}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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). + +```ts Example +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#getsignupidentifiers) + + + + +{/*> **pickCountryCode**(): `Promise`\<`void`\>*/} + +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 `Promise`\<`void`\> + +```ts Example +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#pickcountrycode) + + + + +{/*> **signup**(`payload`): `Promise`\<`void`\>*/} + +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) + + +SignupOptions}> +[`SignupOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/SignupOptions) + + + +- Returns `Promise`\<`void`\> + +#### Remarks + +This methods handles signup-id related configuration. +It allows to signup new users via different identifiers. + +```ts 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); +``` + +- 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#signup) + + + +UsernameValidationResult}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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. + + + +`string` + +The username string to validate. + + + +- Returns [`UsernameValidationResult`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UsernameValidationResult) + +Result object indicating whether the username is valid and why. + +```ts Example +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#validateusername) + \ 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..e5d60baa1 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/SignupPassword.mdx @@ -0,0 +1,285 @@ +--- +title: "SignupPassword" +--- + +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) + + + +```ts Example +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 }, +// ... +// ] +``` + + +- Extends `BaseContext` + +- Implements [`SignupPasswordMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/SignupPasswordMembers) + +## Constructors + + +{/*> **new SignupPassword**(): `SignupPassword`*/} + +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 `SignupPassword` + +- Overrides `BaseContext.constructor` + + +## Properties + +BrandingMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#branding) + +- Inherited from `BaseContext.branding` + + + +ClientMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#client) + +- Inherited from `BaseContext.client` + + + +OrganizationMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#organization) + +- Inherited from `BaseContext.organization` + + + +PromptMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#prompt) + +- Inherited from `BaseContext.prompt` + + + +ScreenMembersOnSignupPassword}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#screen) + +- Overrides `BaseContext.screen` + + + +TenantMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#tenant) + +- Inherited from `BaseContext.tenant` + + + +TransactionMembersOnSignupPassword}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#transaction) + +- Overrides `BaseContext.transaction` + + + +UntrustedDataMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#untrusteddata) + +- Inherited from `BaseContext.untrustedData` + + + +UserMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#user) + +- Inherited from `BaseContext.user` + + + + +{/*> `static` **screenIdentifier**: `string` = `ScreenIds.SIGNUP_PASSWORD`*/} + +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 `BaseContext.screenIdentifier` + + +## Methods + + +{/*> **federatedSignup**(`payload`): `Promise`\<`void`\>*/} + +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) + + +FederatedSignupPasswordPayloadOptions}> +[`FederatedSignupPasswordPayloadOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/FederatedSignupPasswordPayloadOptions) + + + +- Returns `Promise`\<`void`\> + +#### Remarks + +This methods handles allows signup via different social identifiers. +Eg: Google, Facebook etc. + +```ts 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); +``` + +- 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#federatedsignup) + + + +Error[]}> +{/*> **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/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. + +- 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` + + + + +{/*> **signup**(`payload`): `Promise`\<`void`\>*/} + +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) + + +SignupPasswordOptions}> +[`SignupPasswordOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/SignupPasswordOptions) + + + +- 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 + +```ts 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); +``` + +- 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#signup) + + + +PasswordValidationResult}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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. + + + +`string` + +The password string to validate. + + + +- Returns [`PasswordValidationResult`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PasswordValidationResult) + +```ts Example +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#validatepassword) + \ 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..08f9c28bb --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/UserInputError.mdx @@ -0,0 +1,48 @@ +--- +title: "UserInputError" +--- + +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 + +- Extends [`AculError`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/classes/AculError) + +## Constructors + + +{/*> **new UserInputError**(`message`, `field?`): `UserInputError`*/} + +Defined in: [src/utils/errors.ts:33](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/utils/errors.ts#L33) + + + +The error message. + + +The optional field associated with the error. + + +- 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#constructor) + + +## Properties + + +{/*> `readonly` **code**: `"USER_INPUT_ERROR"` = `'USER_INPUT_ERROR'`*/} + +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 [`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#code) + + + + +{/*> `readonly` `optional` **field**: `string`*/} + +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 [`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#field) + \ 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..5e1e46479 --- /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/5c054686de6099ea69493d68134be65604477bb6/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..4d05e6ad3 --- /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/5c054686de6099ea69493d68134be65604477bb6/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..629037e43 --- /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/5c054686de6099ea69493d68134be65604477bb6/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..4f65336e0 --- /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/5c054686de6099ea69493d68134be65604477bb6/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..519083fb3 --- /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/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/passkey-enrollment-local.ts#L19) + + + +```ts Example +export interface AbortEnrollmentOptions { + doNotShowAgain?: boolean; + [key: string]: string | number | boolean | undefined; +} +``` + + +## Indexable + +\[`key`: `string`\]: `string` \| `number` \| `boolean` \| `undefined` + +## Properties + + +{/*> `optional` **doNotShowAgain**: `boolean`*/} + +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) + \ 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..ba00037dc --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/AcceptInvitationMembers.mdx @@ -0,0 +1,127 @@ +--- +title: "AcceptInvitationMembers" +--- + +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) + + + +```ts Example +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; +} +``` + + +- Extends [`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers) + +## Properties + +BrandingMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#branding) + + + +ClientMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#client) + + + +OrganizationMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#organization) + + + +PromptMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#prompt) + + + +ScreenMembersOnAcceptInvitation}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#screen) + + + +TenantMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#tenant) + + + +TransactionMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#transaction) + + + +UntrustedDataMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#untrusteddata) + + + +UserMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#user) + + +## Methods + + +{/*> **acceptInvitation**(`payload?`): `Promise`\<`void`\>*/} + +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. + + +CustomOptions}> +[`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CustomOptions) + +Optional custom options to include with the request. + + + +- Returns `Promise`\<`void`\> + \ 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..700d8134a --- /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/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/screen.ts#L10) + + + +```ts Example +export interface AllowCredential { + type: 'public-key'; + id: Base64URLString; + transports?: AuthenticatorTransport[]; +} +``` + + +## Properties + + +{/*> **id**: `string`*/} + +Defined in: [interfaces/models/screen.ts:12](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/screen.ts#L12) + + + +AuthenticatorTransport}> +{/*> `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/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/screen.ts#L13) + + + + +{/*> **type**: `"public-key"`*/} + +Defined in: [interfaces/models/screen.ts:11](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/screen.ts#L11) + \ 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..ec05eafa5 --- /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/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/screen.ts#L63) + + + +```ts Example +export interface AuthorizationDetail { + type: string; + [key: string]: string; +} +``` + + +## Indexable + +\[`key`: `string`\]: `string` + +## Properties + + +{/*> **type**: `string`*/} + +Defined in: [interfaces/models/screen.ts:64](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/screen.ts#L64) + \ 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..bc2796129 --- /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/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/base-context.ts#L23) + + + +```ts Example +export interface BaseMembers { + branding: BrandingMembers; + client: ClientMembers; + organization: OrganizationMembers; + prompt: PromptMembers; + screen: ScreenMembers; + tenant: TenantMembers; + transaction: TransactionMembers; + user: UserMembers; + untrustedData: UntrustedDataMembers; +} +``` + + +## 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 + +BrandingMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/base-context.ts#L24) + + + +ClientMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/base-context.ts#L25) + + + +OrganizationMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/base-context.ts#L26) + + + +PromptMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/base-context.ts#L27) + + + +ScreenMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/base-context.ts#L28) + + + +TenantMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/base-context.ts#L29) + + + +TransactionMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/base-context.ts#L30) + + + +UntrustedDataMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/base-context.ts#L32) + + + +UserMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/base-context.ts#L31) + \ 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..1b51f788c --- /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/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/organization.ts#L18) + + + +```ts Example +export interface Branding { + logoUrl?: string; + colors?: { + primary?: string; + pageBackground?: string; + }; +} +``` + + +## Properties + + +{/*> `optional` **colors**: `object`*/} + +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? + +{/*> `optional` **pageBackground**: `string`*/} + +#### primary? + +{/*> `optional` **primary**: `string`*/} + + + + +{/*> `optional` **logoUrl**: `string`*/} + +Defined in: [interfaces/models/organization.ts:19](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/organization.ts#L19) + \ 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..7b6f0ce5b --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers.mdx @@ -0,0 +1,146 @@ +--- +title: "BrandingMembers" +--- + +Defined in: [interfaces/models/branding.ts:61](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/branding.ts#L61) + + + +```ts Example +export interface BrandingMembers { + settings: BrandingSettings | null; + themes: BrandingThemes | null; +} +``` + + +## Properties + +BrandingSettings}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/branding.ts#L62) + + + +BrandingThemes}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/branding.ts#L63) + + +## BrandingSettings + +Defined in: [interfaces/models/branding.ts:32](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/branding.ts#L32) + +```ts +export interface BrandingSettings { + colors?: { + primary?: string; + pageBackground?: + | string + | { + type: string; + start: string; + end: string; + angleDegree: number; + }; + }; + faviconUrl?: string; + logoUrl?: string; + fontUrl?: string; +} +``` + +### Properties + + +{/*> `optional` **colors**: `object`*/} + +Defined in: [interfaces/models/branding.ts:33](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/branding.ts#L33) + + + +{/*> `optional` **pageBackground**: `string` \| \{ `angleDegree`: `number`; `end`: `string`; `start`: `string`; `type`: `string`; \}*/} + + + +{/*> `optional` **primary**: `string`*/} + + + + + + +{/*> `optional` **faviconUrl**: `string`*/} + +Defined in: [interfaces/models/branding.ts:44](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/branding.ts#L44) + + + + +{/*> `optional` **fontUrl**: `string`*/} + +Defined in: [interfaces/models/branding.ts:46](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/branding.ts#L46) + + + + +{/*> `optional` **logoUrl**: `string`*/} + +Defined in: [interfaces/models/branding.ts:45](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/branding.ts#L45) + + +## BrandingThemes + + +Defined in: [interfaces/models/branding.ts:49](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/branding.ts#L49) + + +```ts +export interface BrandingThemes { + default: { + borders: Record; + colors: Record; + displayName: string; + fonts: Record; + pageBackground: Record; + widget: Record; + }; +} +``` + +### Properties + + +{/*> **default**: `object`*/} + +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**: `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`\>*/} + + + \ 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..1dfa25301 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingSettings.mdx @@ -0,0 +1,66 @@ +--- +title: "BrandingSettings" +--- + +Defined in: [interfaces/models/branding.ts:32](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/branding.ts#L32) + + + +```ts Example +export interface BrandingSettings { + colors?: { + primary?: string; + pageBackground?: + | string + | { + type: string; + start: string; + end: string; + angleDegree: number; + }; + }; + faviconUrl?: string; + logoUrl?: string; + fontUrl?: string; +} +``` + + +## Properties + + +{/*> `optional` **colors**: `object`*/} + +Defined in: [interfaces/models/branding.ts:33](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/branding.ts#L33) + + + +{/*> `optional` **pageBackground**: `string` \| \{ `angleDegree`: `number`; `end`: `string`; `start`: `string`; `type`: `string`; \}*/} + + + +{/*> `optional` **primary**: `string`*/} + + + + + + +{/*> `optional` **faviconUrl**: `string`*/} + +Defined in: [interfaces/models/branding.ts:44](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/branding.ts#L44) + + + + +{/*> `optional` **fontUrl**: `string`*/} + +Defined in: [interfaces/models/branding.ts:46](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/branding.ts#L46) + + + + +{/*> `optional` **logoUrl**: `string`*/} + +Defined in: [interfaces/models/branding.ts:45](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/branding.ts#L45) + \ 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..728129ec8 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingThemes.mdx @@ -0,0 +1,56 @@ +--- +title: "BrandingThemes" +--- + +Defined in: [interfaces/models/branding.ts:49](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/branding.ts#L49) + + + +```ts Example +export interface BrandingThemes { + default: { + borders: Record; + colors: Record; + displayName: string; + fonts: Record; + pageBackground: Record; + widget: Record; + }; +} +``` + + +## Properties + + +{/*> **default**: `object`*/} + +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**: `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`\>*/} + + + \ 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..d3b85b08e --- /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/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/screen.ts#L1) + + + +```ts Example +export interface CaptchaContext { + provider: string; + image?: string; + siteKey?: string; +} +``` + + +## Properties + + +{/*> `optional` **image**: `string`*/} + +Defined in: [interfaces/models/screen.ts:3](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/screen.ts#L3) + + + + +{/*> **provider**: `string`*/} + +Defined in: [interfaces/models/screen.ts:2](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/screen.ts#L2) + + + + +{/*> `optional` **siteKey**: `string`*/} + +Defined in: [interfaces/models/screen.ts:4](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/screen.ts#L4) + \ 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..2494ec7ec --- /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/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/client.ts#L12) + + + +```ts Example +export interface ClientMembers { + id: string; + name: string; + logoUrl: string | null; + description: string | null; + metadata: { [key: string]: string } | null; +} +``` + + +## Properties + + +{/*> **description**: `string` \| `null`*/} + +Defined in: [interfaces/models/client.ts:16](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/client.ts#L16) + + + + +{/*> **id**: `string`*/} + +Defined in: [interfaces/models/client.ts:13](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/client.ts#L13) + + + + +{/*> **logoUrl**: `string` \| `null`*/} + +Defined in: [interfaces/models/client.ts:15](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/client.ts#L15) + + + + +{/*> **metadata**: \{\[`key`: `string`\]: `string`; \} \| `null`*/} + +Defined in: [interfaces/models/client.ts:17](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/client.ts#L17) + + + + +{/*> **name**: `string`*/} + +Defined in: [interfaces/models/client.ts:14](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/client.ts#L14) + \ 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..0b46765f8 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ConfirmLogoutOptions.mdx @@ -0,0 +1,33 @@ +--- +title: "ConfirmLogoutOptions" +--- + +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 + + + +```ts Example +export interface ConfirmLogoutOptions extends CustomOptions { + /** The authentication transaction state */ + action: 'accept' | 'deny'; +} +``` + + +- Extends [`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CustomOptions) + +## Indexable + +\[`key`: `string`\]: `string` \| `number` \| `boolean` \| `undefined` + +## Properties + + +{/*> **action**: `"accept"` \| `"deny"`*/} + +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 + \ 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..a3ea648a1 --- /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/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/transaction.ts#L1) + + + +```ts Example +export interface Connection { + name: string; + strategy: string; + metadata?: Record; +} +``` + + +## Extended by + +- [`EnterpriseConnection`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/EnterpriseConnection) + +## Properties + + +{/*> `optional` **metadata**: `Record`\<`string`, `string`\>*/} + +Defined in: [interfaces/models/transaction.ts:4](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/transaction.ts#L4) + + + + +{/*> **name**: `string`*/} + +Defined in: [interfaces/models/transaction.ts:2](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/transaction.ts#L2) + + + + +{/*> **strategy**: `string`*/} + +Defined in: [interfaces/models/transaction.ts:3](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/transaction.ts#L3) + \ 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..9d3c92dfb --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ConsentMembers.mdx @@ -0,0 +1,251 @@ +--- +title: "ConsentMembers" +--- + +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 + + + +```ts Example +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} 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; + + /** + * 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} 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; +} +``` + + +- Extends [`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers) + +## Properties + +BrandingMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#branding) + + + +ClientMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#client) + + + +OrganizationMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#organization) + + + +PromptMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#prompt) + + + +ScreenMembersOnConsent}> +{/*> **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/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. + +- 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#screen) + + + +TenantMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#tenant) + + + +TransactionMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#transaction) + + + +UntrustedDataMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#untrusteddata) + + + +UserMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#user) + + +## Methods + + +{/*> **accept**(`payload?`): `Promise`\<`void`\>*/} + +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"`. + + +CustomOptions}> +[`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. + + + +- 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. + +```typescript Example +// 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. +``` + + + + +{/*> **deny**(`payload?`): `Promise`\<`void`\>*/} + +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"`. + + +CustomOptions}> +[`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. + + + +- 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`. + +```typescript Example +// 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. +``` + \ 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..a753c89c4 --- /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/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/mfa-otp-challenge.ts#L26) + +Options for continuing with the OTP challenge + + + +```ts Example +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; +} +``` + + +## Indexable + +\[`key`: `string`\]: `string` \| `number` \| `boolean` \| `undefined` + +Any additional custom options + +## Properties + + +{/*> **code**: `string`*/} + +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 + + + + +{/*> `optional` **rememberDevice**: `boolean`*/} + +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 + \ 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..3d735fce5 --- /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/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/reset-password-mfa-email-challenge.ts#L17) + +Options for continuing with the email challenge. + + + +```ts Example +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; +} +``` + + +## Indexable + +\[`key`: `string`\]: `string` \| `number` \| `boolean` \| `undefined` + +Any additional custom options + +## Properties + + +{/*> **code**: `string`*/} + +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. + + + + +{/*> `optional` **rememberDevice**: `boolean`*/} + +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. + \ 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..d28581ccf --- /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/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/mfa-email-challenge.ts#L29) + +Options for continuing with the email challenge + + + +```ts Example +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; +} +``` + + +## Indexable + +\[`key`: `string`\]: `string` \| `number` \| `boolean` \| `undefined` + +Any additional custom options + +## Properties + + +{/*> **code**: `string`*/} + +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 + + + + +{/*> `optional` **rememberDevice**: `boolean`*/} + +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 + \ 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..c0034e9e0 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ContinueWithCodeOptionPayload.mdx @@ -0,0 +1,54 @@ +--- +title: "ContinueWithCodeOptionPayload" +--- + +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. +This operation is used when the user submits the verification code they received via email +to proceed with the authentication flow. + + + +```ts Example +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; +} +``` + + +- Extends [`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CustomOptions) + +## Indexable + +\[`key`: `string`\]: `string` \| `number` \| `boolean` \| `undefined` + +## Properties + + +{/*> **code**: `string`*/} + +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. + + +```ts Example 1 +"123456" +``` + +```ts Example 2 +"ABCXYZ" +``` + + + \ 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..2463497b2 --- /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/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/organization-selection.ts#L12) + +Options for continuing with the selected organization name. + + + +```ts Example +export interface ContinueWithOrganizationNameOptions { + /** + * The organization name. + */ + organizationName: string; + /** + * Any additional custom options. + */ + [key: string]: string | number | boolean | undefined; +} +``` + + +## Indexable + +\[`key`: `string`\]: `string` \| `number` \| `boolean` \| `undefined` + +Any additional custom options. + +## Properties + + +{/*> **organizationName**: `string`*/} + +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. + \ 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..37b48d749 --- /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/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/utils/passkeys.ts#L15) + + + +```ts Example +export interface CredentialResponse { + clientDataJSON: string | null; + attestationObject: string | null; + transports?: string[]; +} +``` + + +## Properties + + +{/*> **attestationObject**: `string` \| `null`*/} + +Defined in: [interfaces/utils/passkeys.ts:17](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/utils/passkeys.ts#L17) + + + + +{/*> **clientDataJSON**: `string` \| `null`*/} + +Defined in: [interfaces/utils/passkeys.ts:16](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/utils/passkeys.ts#L16) + + + + +{/*> `optional` **transports**: `string`[]*/} + +Defined in: [interfaces/utils/passkeys.ts:18](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/utils/passkeys.ts#L18) + \ 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..d20fac1f4 --- /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/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/common/index.ts#L27) + +CurrentScreenOptions details. + + + +```ts Example +export interface CurrentScreenOptions { + client: { + id: string; + metadata: Record | null; + } | null; + organization: { + id: string; + metadata: Record | 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 | null; + } | null; +} +``` + + +## Properties + + +{/*> **client**: \{ `id`: `string`; `metadata`: `Record`\<`string`, `string`\> \| `null`; \} \| `null`*/} + +Defined in: [interfaces/common/index.ts:28](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/common/index.ts#L28) + + + + +{/*> **organization**: \{ `id`: `string`; `metadata`: `Record`\<`string`, `string`\> \| `null`; \} \| `null`*/} + +Defined in: [interfaces/common/index.ts:32](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/common/index.ts#L32) + + + + +{/*> **prompt**: \{ `name`: `string`; \} \| `null`*/} + +Defined in: [interfaces/common/index.ts:36](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/common/index.ts#L36) + + + + +{/*> **screen**: \{ `name`: `string`; \} \| `null`*/} + +Defined in: [interfaces/common/index.ts:39](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/common/index.ts#L39) + + + + +{/*> **tenant**: \{ `enabledLocales`: `string`[]; \} \| `null`*/} + +Defined in: [interfaces/common/index.ts:42](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/common/index.ts#L42) + + + +Error}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/common/index.ts#L45) + + + + +{/*> **untrustedData**: \{ `authorizationParams`: `Record`\<`string`, `string`\> \| `null`; \} \| `null`*/} + +Defined in: [interfaces/common/index.ts:50](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/common/index.ts#L50) + \ 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..0fcb93283 --- /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/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/common/index.ts#L2) + + + +```ts Example +export interface CustomOptions { + [key: string]: string | number | boolean | undefined; +} +``` + + +## 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..2afeea200 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CustomizedConsentMembers.mdx @@ -0,0 +1,255 @@ +--- +title: "CustomizedConsentMembers" +--- + +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 + + + +```ts Example +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} 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; + + /** + * 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} 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; +} +``` + + +- Extends [`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers) + +## Properties + +BrandingMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#branding) + + + +ClientMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#client) + + + +OrganizationMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#organization) + + + +PromptMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#prompt) + + + +ScreenMembersOnCustomizedConsent}> +{/*> **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/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. + +- 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#screen) + + + +TenantMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#tenant) + + + +TransactionMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#transaction) + + + +UntrustedDataMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#untrusteddata) + + + +UserMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#user) + + +## Methods + + +{/*> **accept**(`payload?`): `Promise`\<`void`\>*/} + +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"`. +The transaction state is automatically included. + + +CustomOptions}> +[`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. + + + +- 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. + +```typescript Example +// 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. +``` + + + + +{/*> **deny**(`payload?`): `Promise`\<`void`\>*/} + +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"`. +The transaction state is automatically included. + + +CustomOptions}> +[`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. + + + +- 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`. + +```typescript Example +// 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. +``` + \ 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..636825389 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/DeviceCodeActivationAllowedMembers.mdx @@ -0,0 +1,98 @@ +--- +title: "DeviceCodeActivationAllowedMembers" +--- + +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. + + + +```ts Example +export interface DeviceCodeActivationAllowedMembers extends BaseMembers {} +``` + + +- Extends [`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers) + +## Properties + +BrandingMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#branding) + + + +ClientMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#client) + + + +OrganizationMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#organization) + + + +PromptMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#prompt) + + + +ScreenMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#screen) + + + +TenantMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#tenant) + + + +TransactionMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#transaction) + + + +UntrustedDataMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#untrusteddata) + + + +UserMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#user) + \ 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..ff8b2f948 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/DeviceCodeActivationContinueOptions.mdx @@ -0,0 +1,34 @@ +--- +title: "DeviceCodeActivationContinueOptions" +--- + +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. + +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. + + + +```ts Example +export interface ContinueOptions extends CustomOptions { + code: string; +} +``` + + +- Extends [`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CustomOptions) + +## Indexable + +\[`key`: `string`\]: `string` \| `number` \| `boolean` \| `undefined` + +## Properties + + +{/*> **code**: `string`*/} + +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) + \ 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..acda1e549 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/DeviceCodeActivationDeniedMembers.mdx @@ -0,0 +1,98 @@ +--- +title: "DeviceCodeActivationDeniedMembers" +--- + +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. + + + +```ts Example +export interface DeviceCodeActivationDeniedMembers extends BaseMembers {} +``` + + +- Extends [`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers) + +## Properties + +BrandingMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#branding) + + + +ClientMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#client) + + + +OrganizationMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#organization) + + + +PromptMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#prompt) + + + +ScreenMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#screen) + + + +TenantMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#tenant) + + + +TransactionMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#transaction) + + + +UntrustedDataMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#untrusteddata) + + + +UserMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#user) + \ 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..27b8d0a52 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/DeviceCodeActivationMembers.mdx @@ -0,0 +1,134 @@ +--- +title: "DeviceCodeActivationMembers" +--- + +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. + + + +```ts Example +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} A promise that resolves when the code is successfully submitted. + * Rejects with an error if the submission fails. + */ + continue(payload: ContinueOptions): Promise; +} +``` + + +- Extends [`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers) + +## Properties + +BrandingMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#branding) + + + +ClientMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#client) + + + +OrganizationMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#organization) + + + +PromptMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#prompt) + + + +ScreenMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#screen) + + + +TenantMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#tenant) + + + +TransactionMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#transaction) + + + +UntrustedDataMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#untrusteddata) + + + +UserMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#user) + + +## Methods + + +{/*> **continue**(`payload`): `Promise`\<`void`\>*/} + +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. + + +DeviceCodeActivationContinueOptions}> +[`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. + + + +- Returns `Promise`\<`void`\> + +A promise that resolves when the code is successfully submitted. +Rejects with an error if the submission fails. + \ 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..4ca5191f8 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/DeviceCodeConfirmationMembers.mdx @@ -0,0 +1,151 @@ +--- +title: "DeviceCodeConfirmationMembers" +--- + +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. + + + +```ts Example +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; + + /** + * Cancels the device code flow. + * @param payload Optional custom options to include with the request. + */ + cancel(payload?: CustomOptions): Promise; +} +``` + + +- Extends [`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers) + +## Properties + +BrandingMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#branding) + + + +ClientMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#client) + + + +OrganizationMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#organization) + + + +PromptMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#prompt) + + + +ScreenMembersOnDeviceCodeConfirmation}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#screen) + + + +TenantMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#tenant) + + + +TransactionMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#transaction) + + + +UntrustedDataMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#untrusteddata) + + + +UserMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#user) + + +## Methods + + +{/*> **cancel**(`payload?`): `Promise`\<`void`\>*/} + +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. + + +CustomOptions}> +[`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CustomOptions) + +Optional custom options to include with the request. + + + +- Returns `Promise`\<`void`\> + + + + +{/*> **confirm**(`payload?`): `Promise`\<`void`\>*/} + +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. + + +CustomOptions}> +[`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CustomOptions) + +Optional custom options to include with the request. + + + +- Returns `Promise`\<`void`\> + \ 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..6a1ff4c4c --- /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/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/email-identifier-challenge.ts#L6) + + + +```ts Example +export interface EmailChallengeOptions { + code: string; + captcha?: string; + [key: string]: string | number | boolean | undefined; +} +``` + + +## Indexable + +\[`key`: `string`\]: `string` \| `number` \| `boolean` \| `undefined` + +## Properties + + +{/*> `optional` **captcha**: `string`*/} + +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) + + + + +{/*> **code**: `string`*/} + +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) + \ 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..ff9ce3c38 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/EmailIdentifierChallengeMembers.mdx @@ -0,0 +1,163 @@ +--- +title: "EmailIdentifierChallengeMembers" +--- + +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) + + + +```ts Example +export interface EmailIdentifierChallengeMembers extends BaseMembers { + screen: ScreenMembersOnEmailIdentifierChallenge; + submitEmailChallenge(payload: EmailChallengeOptions): Promise; + resendCode(payload?: CustomOptions): Promise; + resendManager(payload?: StartResendOptions): ResendControl; + returnToPrevious(payload?: CustomOptions): Promise; +} +``` + + +- Extends [`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers) + +## Properties + +BrandingMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#branding) + + + +ClientMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#client) + + + +OrganizationMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#organization) + + + +PromptMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#prompt) + + + +ScreenMembersOnEmailIdentifierChallenge}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#screen) + + + +TenantMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#tenant) + + + +TransactionMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#transaction) + + + +UntrustedDataMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#untrusteddata) + + + +UserMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#user) + + +## Methods + + +{/*> **resendCode**(`payload?`): `Promise`\<`void`\>*/} + +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) + + +CustomOptions}> +[`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CustomOptions) + + + +- Returns `Promise`\<`void`\> + + + +ResendControl}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/email-identifier-challenge.ts#L24) + + +StartResendOptions}> +[`StartResendOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/StartResendOptions) + + + +- Returns [`ResendControl`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResendControl) + + + + +{/*> **returnToPrevious**(`payload?`): `Promise`\<`void`\>*/} + +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) + + +CustomOptions}> +[`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CustomOptions) + + + +- Returns `Promise`\<`void`\> + + + + +{/*> **submitEmailChallenge**(`payload`): `Promise`\<`void`\>*/} + +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) + + +EmailChallengeOptions}> +[`EmailChallengeOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/EmailChallengeOptions) + + + +- Returns `Promise`\<`void`\> + \ 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..5b45e8b0d --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/EmailOTPChallengeMembers.mdx @@ -0,0 +1,173 @@ +--- +title: "EmailOTPChallengeMembers" +--- + +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. + + + +```ts Example +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; + /** + * 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; + /** + * Gets resend functionality with timeout management for this screen + * @param options Configuration options for resend functionality + */ + resendManager(options?: StartResendOptions): ResendControl; +} +``` + + +- Extends [`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers) + +## Properties + +BrandingMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#branding) + + + +ClientMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#client) + + + +OrganizationMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#organization) + + + +PromptMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#prompt) + + + +ScreenMembersOnEmailOTPChallenge}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#screen) + + + +TenantMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#tenant) + + + +TransactionMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#transaction) + + + +UntrustedDataMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#untrusteddata) + + + +UserMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#user) + + +## Methods + + +{/*> **resendCode**(`options?`): `Promise`\<`void`\>*/} + +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. + + +CustomOptions}> +[`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CustomOptions) + +Optional parameters to include in the resend request. + + + +- Returns `Promise`\<`void`\> + + + +ResendControl}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/email-otp-challenge.ts#L41) + +Gets resend functionality with timeout management for this screen + + +StartResendOptions}> +[`StartResendOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/StartResendOptions) + +Configuration options for resend functionality + + + +- Returns [`ResendControl`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResendControl) + + + + +{/*> **submitCode**(`options`): `Promise`\<`void`\>*/} + +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. + + +OtpCodeOptions}> +[`OtpCodeOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OtpCodeOptions) + +Optional parameters to include in the submission. + + + +- Returns `Promise`\<`void`\> + \ 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..b6575c83c --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/EmailVerificationResultMembers.mdx @@ -0,0 +1,107 @@ +--- +title: "EmailVerificationResultMembers" +--- + +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 + + + +```ts Example +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; +} +``` + + +- Extends [`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers) + +## Properties + +BrandingMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#branding) + + + +ClientMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#client) + + + +OrganizationMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#organization) + + + +PromptMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#prompt) + + + +ScreenMembersOnEmailVerificationResult}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#screen) + + + +TenantMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#tenant) + + + +TransactionMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#transaction) + + + +UntrustedDataMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#untrusteddata) + + + +UserMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#user) + \ 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..8a0aec2fe --- /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/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/user.ts#L12) + + + +```ts Example +export interface EnrolledDevice { + id: number; + device: string; +} +``` + + +## Properties + + +{/*> **device**: `string`*/} + +Defined in: [interfaces/models/user.ts:14](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/user.ts#L14) + + + + +{/*> **id**: `number`*/} + +Defined in: [interfaces/models/user.ts:13](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/user.ts#L13) + \ 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..6d3611303 --- /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/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/user.ts#L2) + + + +```ts Example +export interface EnrolledEmail { + id: number; + email: string; +} +``` + + +## Properties + + +{/*> **email**: `string`*/} + +Defined in: [interfaces/models/user.ts:4](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/user.ts#L4) + + + + +{/*> **id**: `number`*/} + +Defined in: [interfaces/models/user.ts:3](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/user.ts#L3) + \ 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..85ed8b6b0 --- /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/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/user.ts#L7) + + + +```ts Example +export interface EnrolledPhoneNumber { + id: number; + phoneNumber: string; +} +``` + + +## Properties + + +{/*> **id**: `number`*/} + +Defined in: [interfaces/models/user.ts:8](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/user.ts#L8) + + + + +{/*> **phoneNumber**: `string`*/} + +Defined in: [interfaces/models/user.ts:9](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/user.ts#L9) + \ 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..605717eaa --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/EnterpriseConnection.mdx @@ -0,0 +1,70 @@ +--- +title: "EnterpriseConnection" +--- + +Defined in: [interfaces/models/transaction.ts:126](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/transaction.ts#L126) + + + +```ts Example +export interface EnterpriseConnection extends Connection { + options: { + iconUrl?: string; + displayName?: string; + showAsButton: boolean; + }; +} +``` + + +- Extends [`Connection`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Connection) + +## Properties + + +{/*> `optional` **metadata**: `Record`\<`string`, `string`\>*/} + +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 [`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#metadata) + + + + +{/*> **name**: `string`*/} + +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 [`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#name) + + + + +{/*> **options**: `object`*/} + +Defined in: [interfaces/models/transaction.ts:127](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/transaction.ts#L127) + + + + + +{/*> `optional` **displayName**: `string`*/} + + + +{/*> `optional` **iconUrl**: `string`*/} + + + +{/*> **showAsButton**: `boolean`*/} + + + + + +{/*> **strategy**: `string`*/} + +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 [`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#strategy) + \ 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..907acec67 --- /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/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/transaction.ts#L149) + + + +```ts Example +export interface Error { + code: string; + field?: string; + message: string; + rules?: PasswordComplexityRule[]; +} +``` + + +## Properties + + +{/*> **code**: `string`*/} + +Defined in: [interfaces/models/transaction.ts:150](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/transaction.ts#L150) + + + + +{/*> `optional` **field**: `string`*/} + +Defined in: [interfaces/models/transaction.ts:151](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/transaction.ts#L151) + + + + +{/*> **message**: `string`*/} + +Defined in: [interfaces/models/transaction.ts:152](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/transaction.ts#L152) + + + +PasswordComplexityRule[]}> +{/*> `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/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/transaction.ts#L153) + \ 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..b0c6aeb8a --- /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/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/login-id.ts#L52) + + + +```ts Example +export interface FederatedLoginOptions { + connection: string; + [key: string]: string | number | boolean; +} +``` + + +## Indexable + +\[`key`: `string`\]: `string` \| `number` \| `boolean` + +## Properties + + +{/*> **connection**: `string`*/} + +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) + \ 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..5ef0c3cc6 --- /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/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/login-password.ts#L48) + + + +```ts Example +export interface FederatedLoginOptions { + connection: string; + [key: string]: string | number | boolean; +} +``` + + +## Indexable + +\[`key`: `string`\]: `string` \| `number` \| `boolean` + +## Properties + + +{/*> **connection**: `string`*/} + +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) + \ 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..cf4914b75 --- /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/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/login.ts#L70) + +Options for performing social login operations + + + +```ts Example +export interface FederatedLoginOptions { + /** The social connection name to use */ + connection: string; + /** Any additional custom options */ + [key: string]: string | number | boolean; +} +``` + + +## Indexable + +\[`key`: `string`\]: `string` \| `number` \| `boolean` + +Any additional custom options + +## Properties + + +{/*> **connection**: `string`*/} + +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 + \ 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..55290c154 --- /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/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/signup-id.ts#L41) + + + +```ts Example +export interface FederatedSignupOptions { + connection: string; + [key: string]: string | number | boolean; +} +``` + + +## Indexable + +\[`key`: `string`\]: `string` \| `number` \| `boolean` + +## Properties + + +{/*> **connection**: `string`*/} + +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) + \ 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..f8e87ff7d --- /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/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/signup-password.ts#L24) + + + +```ts Example +export interface FederatedSignupOptions { + connection: string; + [key: string]: string | number | boolean; +} +``` + + +## Indexable + +\[`key`: `string`\]: `string` \| `number` \| `boolean` + +## Properties + + +{/*> **connection**: `string`*/} + +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) + \ 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..853016119 --- /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/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/signup.ts#L18) + + + +```ts Example +export interface FederatedSignupOptions { + connection: string; + [key: string]: string | number | boolean; +} +``` + + +## Indexable + +\[`key`: `string`\]: `string` \| `number` \| `boolean` + +## Properties + + +{/*> **connection**: `string`*/} + +Defined in: [interfaces/screens/signup.ts:19](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/signup.ts#L19) + \ 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..e9378e2d6 --- /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/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/common/index.ts#L55) + + + +```ts Example +export interface FlattenedTheme { + colors: Record; + fonts: Record; + borders: Record; + pageBackground: Record; + widget: Record; +} +``` + + +## Properties + + +{/*> **borders**: `Record`\<`string`, `string` \| `number` \| `boolean`\>*/} + +Defined in: [interfaces/common/index.ts:58](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/common/index.ts#L58) + + + + +{/*> **colors**: `Record`\<`string`, `string`\>*/} + +Defined in: [interfaces/common/index.ts:56](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/common/index.ts#L56) + + + + +{/*> **fonts**: `Record`\<`string`, `string` \| `number` \| `boolean` \| `object`\>*/} + +Defined in: [interfaces/common/index.ts:57](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/common/index.ts#L57) + + + + +{/*> **pageBackground**: `Record`\<`string`, `string`\>*/} + +Defined in: [interfaces/common/index.ts:59](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/common/index.ts#L59) + + + + +{/*> **widget**: `Record`\<`string`, `string` \| `number`\>*/} + +Defined in: [interfaces/common/index.ts:60](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/common/index.ts#L60) + \ 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..5c37d5549 --- /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/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. + + + +```ts Example +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; +} +``` + + +## Example + +```ts +const emailIdentifier: Identifier = { + type: 'email', + required: true +}; +``` + +## Properties + + +{/*> **required**: `boolean`*/} + +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. + + + +ScreenIdentifierType}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/utils/signup-identifiers.ts#L36) + +The type of identifier, such as `'email'`, `'phone'`, or `'username'`. + +#### See + +IdentifierType + \ 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..11780058a --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/InterstitialCaptchaMembers.mdx @@ -0,0 +1,112 @@ +--- +title: "InterstitialCaptchaMembers" +--- + +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) + + + +```ts Example +export interface InterstitialCaptchaMembers extends BaseMembers { + submitCaptcha: (payload: SubmitCaptchaOptions) => void; +} +``` + + +- Extends [`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers) + +## Properties + +BrandingMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#branding) + + + +ClientMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#client) + + + +OrganizationMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#organization) + + + +PromptMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#prompt) + + + +ScreenMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#screen) + + + +{/*> **submitCaptcha**: (`payload`) => `void`*/} + +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) + + +SubmitCaptchaOptions}> +[`SubmitCaptchaOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/SubmitCaptchaOptions) + + +- Returns `void` + + + + +TenantMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#tenant) + + + +TransactionMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#transaction) + + + +UntrustedDataMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#untrusteddata) + + + +UserMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#user) + \ 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..1d5c08e5b --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/LoginEmailVerificationMembers.mdx @@ -0,0 +1,337 @@ +--- +title: "LoginEmailVerificationMembers" +--- + +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. +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"). + + + +```ts Example +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} 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; + + /** + * 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} 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; + + /** + * Gets resend functionality with timeout management for this screen + * @param options Configuration options for resend functionality + */ + resendManager(options?: StartResendOptions): ResendControl; +} +``` + + +- Extends [`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers) + +## Properties + +BrandingMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#branding) + + + +ClientMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#client) + + + +OrganizationMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#organization) + + + +PromptMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#prompt) + + + +ScreenMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#screen) + + + +TenantMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#tenant) + + + +TransactionMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#transaction) + + + +UntrustedDataMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#untrusteddata) + + + +UserMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#user) + + +## Methods + + +{/*> **continueWithCode**(`payload`): `Promise`\<`void`\>*/} + +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 +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`). + + +ContinueWithCodeOptionPayload}> +[`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. + + + +- 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. + +```typescript Example +// 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. + } + }); +} +``` + + + + +{/*> **resendCode**(`payload?`): `Promise`\<`void`\>*/} + +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 +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. + + +ResendCodeOptionsPayload}> +[`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. + + + +- 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`. + +```typescript Example +// 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." + } + }); +} +``` + + + +ResendControl}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/login-email-verification.ts#L139) + +Gets resend functionality with timeout management for this screen + + +StartResendOptions}> +[`StartResendOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/StartResendOptions) + +Configuration options for resend functionality + + + +- Returns [`ResendControl`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResendControl) + \ 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..37879b95a --- /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/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/mfa-login-options.ts#L19) + +Options for continuing with a selected MFA factor + + + +```ts Example +export interface LoginEnrollOptions { + /** The action indicating which factor to use for login */ + action: MfaLoginFactorType; + /** Any additional custom options */ + [key: string]: string | number | boolean | undefined; +} +``` + + +## Indexable + +\[`key`: `string`\]: `string` \| `number` \| `boolean` \| `undefined` + +Any additional custom options + +## Properties + +MfaLoginFactorType}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/mfa-login-options.ts#L21) + +The action indicating which factor to use for login + \ 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..5fef14edd --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/LoginIdMembers.mdx @@ -0,0 +1,174 @@ +--- +title: "LoginIdMembers" +--- + +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) + + + +```ts Example +export interface LoginIdMembers extends BaseMembers { + screen: ScreenMembersOnLoginId; + transaction: TransactionMembersOnLoginId; + login(payload: LoginOptions): Promise; + federatedLogin(payload: FederatedLoginOptions): Promise; + passkeyLogin(payload?: CustomOptions): Promise; + pickCountryCode(payload?: CustomOptions): Promise; + getLoginIdentifiers(): IdentifierType[] | null; +} +``` + + +- Extends [`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers) + +## Properties + +BrandingMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#branding) + + + +ClientMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#client) + + + +OrganizationMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#organization) + + + +PromptMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#prompt) + + + +ScreenMembersOnLoginId}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#screen) + + + +TenantMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#tenant) + + + +TransactionMembersOnLoginId}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#transaction) + + + +UntrustedDataMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#untrusteddata) + + + +UserMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#user) + + +## Methods + + +{/*> **federatedLogin**(`payload`): `Promise`\<`void`\>*/} + +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) + + +FederatedLoginOptions}> +[`FederatedLoginOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/FederatedLoginOptions) + + + +- Returns `Promise`\<`void`\> + + + +IdentifierType[]}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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` + + + + +{/*> **login**(`payload`): `Promise`\<`void`\>*/} + +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) + + +LoginOptions}> +[`LoginOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/LoginOptions) + + + +- Returns `Promise`\<`void`\> + + + + +{/*> **passkeyLogin**(`payload?`): `Promise`\<`void`\>*/} + +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) + + +CustomOptions}> +[`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CustomOptions) + + + +- Returns `Promise`\<`void`\> + + + + +{/*> **pickCountryCode**(`payload?`): `Promise`\<`void`\>*/} + +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) + + +CustomOptions}> +[`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CustomOptions) + + + +- Returns `Promise`\<`void`\> + \ 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..9b03a2a17 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/LoginMembers.mdx @@ -0,0 +1,195 @@ +--- +title: "LoginMembers" +--- + +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 + + + +```ts Example +export interface LoginMembers extends BaseMembers { + screen: ScreenMembersOnLogin; + transaction: TransactionMembersOnLogin; + /** + * Performs login with username/password + * @param payload The login options + */ + login(payload: LoginOptions): Promise; + /** + * Performs login with social provider + * @param payload The social login options + */ + federatedLogin(payload: FederatedLoginOptions): Promise; + /** + * Picks country code for phone number input + * @param payload Optional custom options + */ + pickCountryCode(payload?: CustomOptions): Promise; + /** + * 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; +} +``` + + +- Extends [`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers) + +## Properties + +BrandingMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#branding) + + + +ClientMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#client) + + + +OrganizationMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#organization) + + + +PromptMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#prompt) + + + +ScreenMembersOnLogin}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#screen) + + + +TenantMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#tenant) + + + +TransactionMembersOnLogin}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#transaction) + + + +UntrustedDataMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#untrusteddata) + + + +UserMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#user) + + +## Methods + + +{/*> **federatedLogin**(`payload`): `Promise`\<`void`\>*/} + +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 + + +FederatedLoginPayloadOptions}> +[`FederatedLoginPayloadOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/FederatedLoginPayloadOptions) + +The social login options + + + +- Returns `Promise`\<`void`\> + + + +IdentifierType[]}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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 + + + + +{/*> **login**(`payload`): `Promise`\<`void`\>*/} + +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 + + +LoginPayloadOptions}> +[`LoginPayloadOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/LoginPayloadOptions) + +The login options + + + +- Returns `Promise`\<`void`\> + + + + +{/*> **pickCountryCode**(`payload?`): `Promise`\<`void`\>*/} + +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 + + +CustomOptions}> +[`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CustomOptions) + +Optional custom options + + + +- Returns `Promise`\<`void`\> + \ 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..ff7047294 --- /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/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/login-id.ts#L46) + + + +```ts Example +export interface LoginOptions { + username: string; + captcha?: string; + [key: string]: string | number | boolean | undefined; +} +``` + + +## Indexable + +\[`key`: `string`\]: `string` \| `number` \| `boolean` \| `undefined` + +## Properties + + +{/*> `optional` **captcha**: `string`*/} + +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) + + + + +{/*> **username**: `string`*/} + +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) + \ 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..4a3a5258c --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/LoginPasswordMembers.mdx @@ -0,0 +1,132 @@ +--- +title: "LoginPasswordMembers" +--- + +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) + + + +```ts Example +export interface LoginPasswordMembers extends BaseMembers { + screen: ScreenMembersOnLoginPassword; + transaction: TransactionMembersOnLoginPassword; + login(payload: LoginPasswordOptions): Promise; + federatedLogin(payload: FederatedLoginOptions): Promise; +} +``` + + +- Extends [`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers) + +## Properties + +BrandingMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#branding) + + + +ClientMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#client) + + + +OrganizationMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#organization) + + + +PromptMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#prompt) + + + +ScreenMembersOnLoginPassword}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#screen) + + + +TenantMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#tenant) + + + +TransactionMembersOnLoginPassword}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#transaction) + + + +UntrustedDataMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#untrusteddata) + + + +UserMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#user) + + +## Methods + + +{/*> **federatedLogin**(`payload`): `Promise`\<`void`\>*/} + +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) + + +FederatedLoginPasswordOptions}> +[`FederatedLoginPasswordOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/FederatedLoginPasswordOptions) + + + +- Returns `Promise`\<`void`\> + + + + +{/*> **login**(`payload`): `Promise`\<`void`\>*/} + +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) + + +LoginPasswordOptions}> +[`LoginPasswordOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/LoginPasswordOptions) + + + +- Returns `Promise`\<`void`\> + \ 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..7a639e658 --- /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/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/login-password.ts#L41) + + + +```ts Example +export interface LoginPasswordOptions { + username: string; + password: string; + captcha?: string; + [key: string]: string | number | boolean | undefined; +} +``` + + +## Indexable + +\[`key`: `string`\]: `string` \| `number` \| `boolean` \| `undefined` + +## Properties + + +{/*> `optional` **captcha**: `string`*/} + +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) + + + + +{/*> **password**: `string`*/} + +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) + + + + +{/*> **username**: `string`*/} + +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) + \ 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..b174ea528 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/LoginPasswordlessEmailCodeMembers.mdx @@ -0,0 +1,148 @@ +--- +title: "LoginPasswordlessEmailCodeMembers" +--- + +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) + + + +```ts Example +export interface LoginPasswordlessEmailCodeMembers extends BaseMembers { + screen: ScreenMembersOnLoginPasswordlessEmailCode; + transaction: TransactionMembersOnLoginPasswordlessEmailCode; + submitCode(payload: SubmitCodeOptions): Promise; + resendCode(payload?: CustomOptions): Promise; + resendManager(options?: StartResendOptions): ResendControl; +} +``` + + +- Extends [`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers) + +## Properties + +BrandingMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#branding) + + + +ClientMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#client) + + + +OrganizationMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#organization) + + + +PromptMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#prompt) + + + +ScreenMembersOnLoginPasswordlessEmailCode}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#screen) + + + +TenantMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#tenant) + + + +TransactionMembersOnLoginPasswordlessEmailCode}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#transaction) + + + +UntrustedDataMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#untrusteddata) + + + +UserMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#user) + + +## Methods + + +{/*> **resendCode**(`payload?`): `Promise`\<`void`\>*/} + +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) + + +CustomOptions}> +[`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CustomOptions) + + + +- Returns `Promise`\<`void`\> + + + +ResendControl}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/login-passwordless-email-code.ts#L32) + + +StartResendOptions}> +[`StartResendOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/StartResendOptions) + + + +- Returns [`ResendControl`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResendControl) + + + + +{/*> **submitCode**(`payload`): `Promise`\<`void`\>*/} + +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) + + +SubmitCodeOptions}> +[`SubmitCodeOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/SubmitCodeOptions) + + + +- Returns `Promise`\<`void`\> + \ 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..10aa7bdd6 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/LoginPasswordlessSmsOtpMembers.mdx @@ -0,0 +1,156 @@ +--- +title: "LoginPasswordlessSmsOtpMembers" +--- + +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) + + + +```ts Example +export interface LoginPasswordlessSmsOtpMembers extends BaseMembers { + screen: ScreenMembersOnLoginPasswordlessSmsOtp; + transaction: TransactionMembersOnLoginPasswordlessSmsOtp; + submitOTP(payload: SubmitOTPOptions): Promise; + resendOTP(payload?: CustomOptions): Promise; + /** + * Gets resend functionality with timeout management for this screen + * @param options Configuration options for resend functionality + */ + resendManager(options?: StartResendOptions): ResendControl; +} +``` + + +- Extends [`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers) + +## Properties + +BrandingMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#branding) + + + +ClientMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#client) + + + +OrganizationMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#organization) + + + +PromptMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#prompt) + + + +ScreenMembersOnLoginPasswordlessSmsOtp}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#screen) + + + +TenantMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#tenant) + + + +TransactionMembersOnLoginPasswordlessSmsOtp}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#transaction) + + + +UntrustedDataMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#untrusteddata) + + + +UserMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#user) + + +## Methods + +ResendControl}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/login-passwordless-sms-otp.ts#L44) + +Gets resend functionality with timeout management for this screen + + +StartResendOptions}> +[`StartResendOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/StartResendOptions) + +Configuration options for resend functionality + + + +- Returns [`ResendControl`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResendControl) + + + + +{/*> **resendOTP**(`payload?`): `Promise`\<`void`\>*/} + +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) + + +CustomOptions}> +[`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CustomOptions) + + + +- Returns `Promise`\<`void`\> + + + + +{/*> **submitOTP**(`payload`): `Promise`\<`void`\>*/} + +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) + + +SubmitOTPOptions}> +[`SubmitOTPOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/SubmitOTPOptions) + + + +- Returns `Promise`\<`void`\> + \ 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..74acfbc82 --- /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/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/login.ts#L56) + +Options for performing login operations + + + +```ts Example +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; +} +``` + + +## Indexable + +\[`key`: `string`\]: `string` \| `number` \| `boolean` \| `undefined` + +Any additional custom options + +## Properties + + +{/*> `optional` **captcha**: `string`*/} + +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 + + + + +{/*> **password**: `string`*/} + +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 + + + + +{/*> **username**: `string`*/} + +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 + \ 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..340f6b31d --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/LogoutAbortedMembers.mdx @@ -0,0 +1,98 @@ +--- +title: "LogoutAbortedMembers" +--- + +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 + + + +```ts Example +export interface LogoutAbortedMembers extends BaseMembers {} +``` + + +- Extends [`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers) + +## Properties + +BrandingMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#branding) + + + +ClientMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#client) + + + +OrganizationMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#organization) + + + +PromptMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#prompt) + + + +ScreenMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#screen) + + + +TenantMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#tenant) + + + +TransactionMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#transaction) + + + +UntrustedDataMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#untrusteddata) + + + +UserMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#user) + \ 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..d0c5013f8 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/LogoutCompleteMembers.mdx @@ -0,0 +1,98 @@ +--- +title: "LogoutCompleteMembers" +--- + +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 + + + +```ts Example +export interface LogoutCompleteMembers extends BaseMembers {} +``` + + +- Extends [`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers) + +## Properties + +BrandingMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#branding) + + + +ClientMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#client) + + + +OrganizationMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#organization) + + + +PromptMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#prompt) + + + +ScreenMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#screen) + + + +TenantMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#tenant) + + + +TransactionMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#transaction) + + + +UntrustedDataMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#untrusteddata) + + + +UserMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#user) + \ 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..633be0fb7 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/LogoutMembers.mdx @@ -0,0 +1,124 @@ +--- +title: "LogoutMembers" +--- + +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 + + + +```ts Example +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; +} +``` + + +- Extends [`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers) + +## Properties + +BrandingMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#branding) + + + +ClientMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#client) + + + +OrganizationMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#organization) + + + +PromptMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#prompt) + + + +ScreenMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#screen) + + + +TenantMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#tenant) + + + +TransactionMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#transaction) + + + +UntrustedDataMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#untrusteddata) + + + +UserMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#user) + + +## Methods + + +{/*> **confirmLogout**(`payload`): `Promise`\<`void`\>*/} + +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) + + +ConfirmLogoutOptions}> +[`ConfirmLogoutOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ConfirmLogoutOptions) + +The options containing the action to perform + + + +- Returns `Promise`\<`void`\> + \ 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..3d0ae5217 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaBeginEnrollOptionsMembers.mdx @@ -0,0 +1,124 @@ +--- +title: "MfaBeginEnrollOptionsMembers" +--- + +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 + + + +```ts Example +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; +} +``` + + +- Extends [`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers) + +## Properties + +BrandingMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#branding) + + + +ClientMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#client) + + + +OrganizationMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#organization) + + + +PromptMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#prompt) + + + +ScreenMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#screen) + + + +TenantMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#tenant) + + + +TransactionMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#transaction) + + + +UntrustedDataMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#untrusteddata) + + + +UserMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#user) + + +## Methods + + +{/*> **enroll**(`payload`): `Promise`\<`void`\>*/} + +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 + + +MfaEnrollOptions}> +[`MfaEnrollOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaEnrollOptions) + +The enrollment options including the selected factor + + + +- Returns `Promise`\<`void`\> + \ 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..e689c4d48 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaCountryCodesMembers.mdx @@ -0,0 +1,149 @@ +--- +title: "MfaCountryCodesMembers" +--- + +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 + + + +```ts Example +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; + /** + * Navigates back to the previous screen + * @param payload Optional custom options to include with the request + */ + goBack(payload?: CustomOptions): Promise; +} +``` + + +- Extends [`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers) + +## Properties + +BrandingMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#branding) + + + +ClientMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#client) + + + +OrganizationMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#organization) + + + +PromptMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#prompt) + + + +ScreenMembersOnMfaCountryCodes}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#screen) + + + +TenantMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#tenant) + + + +TransactionMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#transaction) + + + +UntrustedDataMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#untrusteddata) + + + +UserMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#user) + + +## Methods + + +{/*> **goBack**(`payload?`): `Promise`\<`void`\>*/} + +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 + + +CustomOptions}> +[`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CustomOptions) + +Optional custom options to include with the request + + + +- Returns `Promise`\<`void`\> + + + + +{/*> **selectCountryCode**(`payload`): `Promise`\<`void`\>*/} + +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 + + +SelectCountryCodeOptions}> +[`SelectCountryCodeOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/SelectCountryCodeOptions) + +The options containing the country code selection action + + + +- Returns `Promise`\<`void`\> + \ 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..e43d73b7c --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaDetectBrowserCapabilitiesMembers.mdx @@ -0,0 +1,134 @@ +--- +title: "MfaDetectBrowserCapabilitiesMembers" +--- + +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 + + + +```ts Example +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; +} +``` + + +- Extends [`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers) + +## Properties + +BrandingMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#branding) + + + +ClientMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#client) + + + +OrganizationMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#organization) + + + +PromptMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#prompt) + + + +ScreenMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#screen) + + + +TenantMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#tenant) + + + +TransactionMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#transaction) + + + +UntrustedDataMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#untrusteddata) + + + +UserMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#user) + + +## Methods + + +{/*> **detectCapabilities**(`payload`): `Promise`\<`void`\>*/} + +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 + + +CustomOptions}> +[`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CustomOptions) + +The options containing browser capability flags + + + +- Returns `Promise`\<`void`\> + +```typescript Example +const mfaDetectBrowserCapabilities = new MfaDetectBrowserCapabilities(); +await mfaDetectBrowserCapabilities.detectCapabilities(); +``` + \ 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..a866b9903 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaEmailChallengeMembers.mdx @@ -0,0 +1,227 @@ +--- +title: "MfaEmailChallengeMembers" +--- + +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 + + + +```ts Example +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; + + /** + * Resends the email code + * @param payload Optional custom options to include with the request + */ + resendCode(payload?: ResendCodeOptions): Promise; + + /** + * Allows the user to try another MFA method + * @param payload Optional custom options to include with the request + */ + tryAnotherMethod(payload?: TryAnotherMethodOptions): Promise; + + /** + * 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; + + /** + * Gets resend functionality with timeout management for this screen + * @param options Configuration options for resend functionality + */ + resendManager(options?: StartResendOptions): ResendControl; +} +``` + + +- Extends [`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers) + +## Properties + +BrandingMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#branding) + + + +ClientMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#client) + + + +OrganizationMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#organization) + + + +PromptMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#prompt) + + + +ScreenMembersOnMfaEmailChallenge}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#screen) + + + +TenantMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#tenant) + + + +TransactionMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#transaction) + + + +UntrustedDataMembersOnMfaEmailChallenge}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#untrusteddata) + + + +UserMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#user) + + +## Methods + + +{/*> **continue**(`payload`): `Promise`\<`void`\>*/} + +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 + + +ContinuePayloadOptions}> +[`ContinuePayloadOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ContinuePayloadOptions) + +The options containing the code and rememberDevice flag + + + +- Returns `Promise`\<`void`\> + + + + +{/*> **pickEmail**(`payload?`): `Promise`\<`void`\>*/} + +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 + + +CustomOptions}> +[`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CustomOptions) + +Optional custom options to include with the request + + + +- Returns `Promise`\<`void`\> + + + + +{/*> **resendCode**(`payload?`): `Promise`\<`void`\>*/} + +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 + + +ResendCodePayloadOptions}> +[`ResendCodePayloadOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResendCodePayloadOptions) + +Optional custom options to include with the request + + + +- Returns `Promise`\<`void`\> + + + +ResendControl}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/mfa-email-challenge.ts#L89) + +Gets resend functionality with timeout management for this screen + + +StartResendOptions}> +[`StartResendOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/StartResendOptions) + +Configuration options for resend functionality + + + +- Returns [`ResendControl`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResendControl) + + + + +{/*> **tryAnotherMethod**(`payload?`): `Promise`\<`void`\>*/} + +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 + + +TryAnotherMethodPayloadOptions}> +[`TryAnotherMethodPayloadOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TryAnotherMethodPayloadOptions) + +Optional custom options to include with the request + + + +- Returns `Promise`\<`void`\> + \ 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..ed909f49a --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaEmailListMembers.mdx @@ -0,0 +1,149 @@ +--- +title: "MfaEmailListMembers" +--- + +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 + + + +```ts Example +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; + /** + * Navigates back to the previous screen + * @param payload Optional custom options to include with the request + */ + goBack(payload?: CustomOptions): Promise; +} +``` + + +- Extends [`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers) + +## Properties + +BrandingMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#branding) + + + +ClientMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#client) + + + +OrganizationMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#organization) + + + +PromptMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#prompt) + + + +ScreenMembersOnMfaEmailList}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#screen) + + + +TenantMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#tenant) + + + +TransactionMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#transaction) + + + +UntrustedDataMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#untrusteddata) + + + +UserMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#user) + + +## Methods + + +{/*> **goBack**(`payload?`): `Promise`\<`void`\>*/} + +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 + + +CustomOptions}> +[`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CustomOptions) + +Optional custom options to include with the request + + + +- Returns `Promise`\<`void`\> + + + + +{/*> **selectMfaEmail**(`payload`): `Promise`\<`void`\>*/} + +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 + + +SelectMfaEmailOptions}> +[`SelectMfaEmailOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/SelectMfaEmailOptions) + +The options containing the selection action + + + +- Returns `Promise`\<`void`\> + \ 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..4ca2a7c44 --- /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/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/mfa-begin-enroll-options.ts#L7) + +Options for continuing with factor enrollment + + + +```ts Example +export interface MfaEnrollOptions { + /** The action indicating which factor to enroll */ + action: MfaEnrollFactorType; + /** Any additional custom options */ + [key: string]: string | number | boolean | undefined; +} +``` + + +## Indexable + +\[`key`: `string`\]: `string` \| `number` \| `boolean` \| `undefined` + +Any additional custom options + +## Properties + +MfaEnrollFactorType}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/mfa-begin-enroll-options.ts#L9) + +The action indicating which factor to enroll + \ 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..d1cb76cf4 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaEnrollResultMembers.mdx @@ -0,0 +1,111 @@ +--- +title: "MfaEnrollResultMembers" +--- + +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 + + + +```ts Example +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. +} +``` + + +- Extends [`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers) + +## Properties + +BrandingMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#branding) + + + +ClientMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#client) + + + +OrganizationMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#organization) + + + +PromptMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#prompt) + + + +ScreenMembersOnMfaEnrollResult}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#screen) + + + +TenantMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#tenant) + + + +TransactionMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#transaction) + + + +UntrustedDataMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#untrusteddata) + + + +UserMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#user) + \ 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..8929bb978 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaLoginOptionsMembers.mdx @@ -0,0 +1,173 @@ +--- +title: "MfaLoginOptionsMembers" +--- + +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 + + + +```ts Example +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; + /** + * 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; +} +``` + + +- Extends [`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers) + +## Properties + +BrandingMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#branding) + + + +ClientMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#client) + + + +OrganizationMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#organization) + + + +PromptMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#prompt) + + + +ScreenMembersOnMfaLoginOptions}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#screen) + + + +TenantMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#tenant) + + + +TransactionMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#transaction) + + + +UntrustedDataMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#untrusteddata) + + + +UserMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#user) + + +## Methods + + +{/*> **enroll**(`payload`): `Promise`\<`void`\>*/} + +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 + + +LoginEnrollOptions}> +[`LoginEnrollOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/LoginEnrollOptions) + +The options containing the selected factor + + + +- Returns `Promise`\<`void`\> + +```typescript Example +const mfaLoginOptions = new MfaLoginOptions(); +await mfaLoginOptions.enroll({ + action: 'push-notification' +}); +``` + + + + +{/*> **returnToPrevious**(`payload?`): `Promise`\<`void`\>*/} + +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 + + +CustomOptions}> +[`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CustomOptions) + +Optional custom options + + + +- Returns `Promise`\<`void`\> + +```typescript Example +const mfaLoginOptions = new MfaLoginOptions(); +await mfaLoginOptions.returnToPrevious(); +``` + \ 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..ff6a3ddac --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaOtpChallengeMembers.mdx @@ -0,0 +1,152 @@ +--- +title: "MfaOtpChallengeMembers" +--- + +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 + + + +```ts Example +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; + + /** + * Allows the user to try another MFA method + * @param payload Optional custom options to include with the request + */ + tryAnotherMethod(payload?: TryAnotherMethodOptions): Promise; +} +``` + + +- Extends [`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers) + +## Properties + +BrandingMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#branding) + + + +ClientMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#client) + + + +OrganizationMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#organization) + + + +PromptMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#prompt) + + + +ScreenMembersOnMfaOtpChallenge}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#screen) + + + +TenantMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#tenant) + + + +TransactionMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#transaction) + + + +UntrustedDataMembersOnMfaOtpChallenge}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#untrusteddata) + + + +UserMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#user) + + +## Methods + + +{/*> **continue**(`payload`): `Promise`\<`void`\>*/} + +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 + + +ContinueOTPOptions}> +[`ContinueOTPOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ContinueOTPOptions) + +The options containing the code and rememberDevice flag + + + +- Returns `Promise`\<`void`\> + + + + +{/*> **tryAnotherMethod**(`payload?`): `Promise`\<`void`\>*/} + +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 + + +TryAnotherMethodMfaOtpChallengeOptions}> +[`TryAnotherMethodMfaOtpChallengeOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TryAnotherMethodMfaOtpChallengeOptions) + +Optional custom options to include with the request + + + +- Returns `Promise`\<`void`\> + \ 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..e337541b0 --- /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/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/mfa-otp-enrollment-code.ts#L7) + +Options for continuing with the MFA OTP enrollment code. + + + +```ts Example +export interface ContinueOptions { + /** + * The OTP code entered by the user. + */ + code: string; + + /** + * Any additional custom options. + */ + [key: string]: string | number | boolean | undefined; +} +``` + + +## Indexable + +\[`key`: `string`\]: `string` \| `number` \| `boolean` \| `undefined` + +Any additional custom options. + +## Properties + + +{/*> **code**: `string`*/} + +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. + \ 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..3a7ec23c8 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaOtpEnrollmentCodeMembers.mdx @@ -0,0 +1,156 @@ +--- +title: "MfaOtpEnrollmentCodeMembers" +--- + +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. + + + +```ts Example +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; + + /** + * Allows the user to try another MFA method. + * @param payload Optional custom options to include with the request. + */ + tryAnotherMethod(payload?: TryAnotherMethodOptions): Promise; +} +``` + + +- Extends [`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers) + +## Properties + +BrandingMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#branding) + + + +ClientMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#client) + + + +OrganizationMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#organization) + + + +PromptMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#prompt) + + + +ScreenMembersOnMfaOtpEnrollmentCode}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#screen) + + + +TenantMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#tenant) + + + +TransactionMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#transaction) + + + +UntrustedDataMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#untrusteddata) + + + +UserMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#user) + + +## Methods + + +{/*> **continue**(`payload`): `Promise`\<`void`\>*/} + +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. + + +MfaOtpContinueOptions}> +[`MfaOtpContinueOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaOtpContinueOptions) + +The options containing the OTP code. + + + +- Returns `Promise`\<`void`\> + + + + +{/*> **tryAnotherMethod**(`payload?`): `Promise`\<`void`\>*/} + +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. + + +MfaOtpTryAnotherMethodOptions}> +[`MfaOtpTryAnotherMethodOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaOtpTryAnotherMethodOptions) + +Optional custom options to include with the request. + + + +- Returns `Promise`\<`void`\> + \ 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..305f2acb8 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaOtpEnrollmentQrContinueOptions.mdx @@ -0,0 +1,30 @@ +--- +title: "MfaOtpEnrollmentQrContinueOptions" +--- + +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 + + + +```ts Example +export interface ContinueOptions extends CustomOptions { + code: string; +} +``` + + +- Extends [`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CustomOptions) + +## Indexable + +\[`key`: `string`\]: `string` \| `number` \| `boolean` \| `undefined` + +## Properties + + +{/*> **code**: `string`*/} + +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) + \ 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..12476a56b --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaOtpEnrollmentQrMembers.mdx @@ -0,0 +1,176 @@ +--- +title: "MfaOtpEnrollmentQrMembers" +--- + +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 + + + +```ts Example +export interface MfaOtpEnrollmentQrMembers extends BaseMembers { + screen: ScreenMembersOnMfaOtpEnrollmentQr; + + /** + * Toggles the view. + * @param payload Optional custom options to include with the request + */ + toggleView(payload?: CustomOptions): Promise; + + /** + * Continues with the default action. + * @param payload Payload containing code and optional custom options + */ + continue(payload: ContinueOptions): Promise; + + /** + * Allows trying another authentication method + * @param payload Optional custom options to include with the request + */ + tryAnotherMethod(payload?: CustomOptions): Promise; +} +``` + + +- Extends [`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers) + +## Properties + +BrandingMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#branding) + + + +ClientMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#client) + + + +OrganizationMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#organization) + + + +PromptMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#prompt) + + + +ScreenMembersOnMfaOtpEnrollmentQr}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#screen) + + + +TenantMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#tenant) + + + +TransactionMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#transaction) + + + +UntrustedDataMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#untrusteddata) + + + +UserMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#user) + + +## Methods + + +{/*> **continue**(`payload`): `Promise`\<`void`\>*/} + +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. + + +MfaOtpEnrollmentQrContinueOptions}> +[`MfaOtpEnrollmentQrContinueOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaOtpEnrollmentQrContinueOptions) + +Payload containing code and optional custom options + + + +- Returns `Promise`\<`void`\> + + + + +{/*> **toggleView**(`payload?`): `Promise`\<`void`\>*/} + +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. + + +CustomOptions}> +[`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CustomOptions) + +Optional custom options to include with the request + + + +- Returns `Promise`\<`void`\> + + + + +{/*> **tryAnotherMethod**(`payload?`): `Promise`\<`void`\>*/} + +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 + + +CustomOptions}> +[`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CustomOptions) + +Optional custom options to include with the request + + + +- Returns `Promise`\<`void`\> + \ 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..a7c63231a --- /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/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/mfa-otp-enrollment-code.ts#L22) + +Options for trying another MFA method. + + + +```ts Example +export interface TryAnotherMethodOptions { + /** + * Any additional custom options. + */ + [key: string]: string | number | boolean | undefined; +} +``` + + +## 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..c3e6cf108 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaPhoneChallengeContinueOptions.mdx @@ -0,0 +1,48 @@ +--- +title: "MfaPhoneChallengeContinueOptions" +--- + +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. +This typically involves selecting the method (SMS or Voice) to receive the verification code. + + + +```ts Example +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'; +} +``` + + +- Extends [`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CustomOptions) + +## Indexable + +\[`key`: `string`\]: `string` \| `number` \| `boolean` \| `undefined` + +## Properties + + +{/*> **type**: `"sms"` \| `"voice"`*/} + +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. +'voice': Send the code via a voice call. + +#### Default + +```ts +'sms' +``` + \ 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..e27f1d7e8 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaPhoneChallengeMembers.mdx @@ -0,0 +1,270 @@ +--- +title: "MfaPhoneChallengeMembers" +--- + +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 + + + +```ts Example +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} 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; + + /** + * 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} 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; + + /** + * 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} 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; +} +``` + + +- Extends [`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers) + +## Properties + +BrandingMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#branding) + + + +ClientMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#client) + + + +OrganizationMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#organization) + + + +PromptMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#prompt) + + + +ScreenMembersOnMfaPhoneChallenge}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#screen) + + + +TenantMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#tenant) + + + +TransactionMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#transaction) + + + +UntrustedDataMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#untrusteddata) + + + +UserMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#user) + + +## Methods + + +{/*> **continue**(`payload`): `Promise`\<`void`\>*/} + +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. +This will trigger sending the verification code to the user's phone. + + +MfaPhoneChallengeContinueOptions}> +[`MfaPhoneChallengeContinueOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/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. + +```typescript Example +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' }); +``` + + + + +{/*> **pickPhone**(`payload?`): `Promise`\<`void`\>*/} + +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. +This typically redirects the user to a screen where they can select from multiple enrolled phone numbers, if applicable. + + +MfaPhoneChallengePickPhoneOptions}> +[`MfaPhoneChallengePickPhoneOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/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. + +```typescript Example +import MfaPhoneChallenge from '@auth0/auth0-acul-js/mfa-phone-challenge'; + +const mfaPhoneChallenge = new MfaPhoneChallenge(); +await mfaPhoneChallenge.pickPhone(); +``` + + + + +{/*> **tryAnotherMethod**(`payload?`): `Promise`\<`void`\>*/} + +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. +This redirects the user to a screen where they can choose an alternative MFA method (e.g., OTP app, recovery code). + + +MfaPhoneChallengePickAuthenticatorOptions}> +[`MfaPhoneChallengePickAuthenticatorOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/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. + +```typescript Example +import MfaPhoneChallenge from '@auth0/auth0-acul-js/mfa-phone-challenge'; + +const mfaPhoneChallenge = new MfaPhoneChallenge(); +await mfaPhoneChallenge.tryAnotherMethod(); +``` + \ 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..1897e8d29 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaPhoneChallengePickAuthenticatorOptions.mdx @@ -0,0 +1,22 @@ +--- +title: "MfaPhoneChallengePickAuthenticatorOptions" +--- + +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. +This allows the user to choose a different MFA method if available. + + + +```ts Example +export interface PickAuthenticatorOptions extends CustomOptions {} +``` + + +- 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..bd33f8925 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaPhoneChallengePickPhoneOptions.mdx @@ -0,0 +1,23 @@ +--- +title: "MfaPhoneChallengePickPhoneOptions" +--- + +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. +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. + + + +```ts Example +export interface PickPhoneOptions extends CustomOptions {} +``` + + +- 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..18762c7f5 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaPhoneEnrollmentContinueOptions.mdx @@ -0,0 +1,40 @@ +--- +title: "MfaPhoneEnrollmentContinueOptions" +--- + +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. + +Extends `CustomOptions` to allow passing custom options alongside phone and type. + + + +```ts Example +export interface ContinueOptions extends CustomOptions { + phone: string; + type: 'sms' | 'voice'; +} +``` + + +- Extends [`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CustomOptions) + +## Indexable + +\[`key`: `string`\]: `string` \| `number` \| `boolean` \| `undefined` + +## Properties + + +{/*> **phone**: `string`*/} + +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) + + + + +{/*> **type**: `"sms"` \| `"voice"`*/} + +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) + \ 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..2a503b6b7 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaPhoneEnrollmentMembers.mdx @@ -0,0 +1,178 @@ +--- +title: "MfaPhoneEnrollmentMembers" +--- + +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) + + + +```ts Example +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; + + /** + * 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; + + /** + * Allows the user to try another MFA method. + * @param payload Optional custom options to include with the request. + */ + tryAnotherMethod(payload?: CustomOptions): Promise; +} +``` + + +- Extends [`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers) + +## Properties + +BrandingMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#branding) + + + +ClientMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#client) + + + +OrganizationMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#organization) + + + +PromptMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#prompt) + + + +ScreenMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#screen) + + + +TenantMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#tenant) + + + +TransactionMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#transaction) + + + +UntrustedDataMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#untrusteddata) + + + +UserMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#user) + + +## Methods + + +{/*> **continueEnrollment**(`payload`): `Promise`\<`void`\>*/} + +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). + + +MfaPhoneEnrollmentContinueOptions}> +[`MfaPhoneEnrollmentContinueOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaPhoneEnrollmentContinueOptions) + +The phone number, type, and optional custom options. + + + +- Returns `Promise`\<`void`\> + + + + +{/*> **pickCountryCode**(`payload?`): `Promise`\<`void`\>*/} + +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. + + +CustomOptions}> +[`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CustomOptions) + +Optional custom options to include with the request. + + + +- Returns `Promise`\<`void`\> + + + + +{/*> **tryAnotherMethod**(`payload?`): `Promise`\<`void`\>*/} + +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. + + +CustomOptions}> +[`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CustomOptions) + +Optional custom options to include with the request. + + + +- Returns `Promise`\<`void`\> + \ 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..bf1672883 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaPushChallengePushMembers.mdx @@ -0,0 +1,230 @@ +--- +title: "MfaPushChallengePushMembers" +--- + +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 + + + +```ts Example +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; + + /** + * Resends the push notification + * @param payload Optional custom options to include with the request + */ + resendPushNotification(payload?: WithRememberOptions): Promise; + + /** + * Switches to entering the verification code manually + * @param payload Optional custom options to include with the request + */ + enterCodeManually(payload?: CustomOptions): Promise; + + /** + * Allows trying another authentication method + * @param payload Optional custom options to include with the request + */ + tryAnotherMethod(payload?: CustomOptions): Promise; + + /** + * 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; +} +``` + + +- Extends [`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers) + +## Properties + +BrandingMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#branding) + + + +ClientMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#client) + + + +OrganizationMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#organization) + + + +PromptMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#prompt) + + + +ScreenMembersOnMfaPushChallengePush}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#screen) + + + +TenantMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#tenant) + + + +TransactionMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#transaction) + + + +UntrustedDataMembersOnMfaPushChallengePush}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#untrusteddata) + + + +UserMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#user) + + +## Methods + + +{/*> **continue**(`payload?`): `Promise`\<`void`\>*/} + +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 + + +WithRememberOptions}> +[`WithRememberOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/WithRememberOptions) + +Optional custom options to include with the request + + + +- Returns `Promise`\<`void`\> + + + + +{/*> **enterCodeManually**(`payload?`): `Promise`\<`void`\>*/} + +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 + + +CustomOptions}> +[`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CustomOptions) + +Optional custom options to include with the request + + + +- Returns `Promise`\<`void`\> + + + +MfaPushPollingControl}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/mfa-push-challenge-push.ts#L72) + +Manages polling for MFA push challenge status + + +MfaPollingOptions}> +[`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) + + + +- Returns [`MfaPushPollingControl`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaPushPollingControl) + +An object to control the polling process + + + + +{/*> **resendPushNotification**(`payload?`): `Promise`\<`void`\>*/} + +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 + + +WithRememberOptions}> +[`WithRememberOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/WithRememberOptions) + +Optional custom options to include with the request + + + +- Returns `Promise`\<`void`\> + + + + +{/*> **tryAnotherMethod**(`payload?`): `Promise`\<`void`\>*/} + +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 + + +CustomOptions}> +[`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CustomOptions) + +Optional custom options to include with the request + + + +- Returns `Promise`\<`void`\> + \ 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..ee0776002 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaPushEnrollmentQrMembers.mdx @@ -0,0 +1,143 @@ +--- +title: "MfaPushEnrollmentQrMembers" +--- + +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 + + + +```ts Example +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; + + pollingManager(options: MfaPollingOptions): MfaPushPollingControl; + +} +``` + + +- Extends [`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers) + +## Properties + +BrandingMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#branding) + + + +ClientMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#client) + + + +OrganizationMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#organization) + + + +PromptMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#prompt) + + + +ScreenMembersOnMfaPushEnrollmentQr}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#screen) + + + +TenantMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#tenant) + + + +TransactionMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#transaction) + + + +UntrustedDataMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#untrusteddata) + + + +UserMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#user) + + +## Methods + + +{/*> **pickAuthenticator**(`payload?`): `Promise`\<`void`\>*/} + +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. + + +CustomOptions}> +[`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CustomOptions) + +Optional custom options to include with the request + + + +- Returns `Promise`\<`void`\> + + + +MfaPushPollingControl}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/mfa-push-enrollment-qr.ts#L32) + + +MfaPollingOptions}> +[`MfaPollingOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/type-aliases/MfaPollingOptions) + + + +- Returns [`MfaPushPollingControl`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaPushPollingControl) + \ 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..76e035b10 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaPushListMembers.mdx @@ -0,0 +1,148 @@ +--- +title: "MfaPushListMembers" +--- + +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 + + + +```ts Example +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; + /** + * Navigates back to the previous screen. + * @param payload Optional custom options to include with the request. + */ + goBack(payload?: CustomOptions): Promise; +} +``` + + +- Extends [`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers) + +## Properties + +BrandingMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#branding) + + + +ClientMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#client) + + + +OrganizationMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#organization) + + + +PromptMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#prompt) + + + +ScreenMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#screen) + + + +TenantMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#tenant) + + + +TransactionMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#transaction) + + + +UntrustedDataMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#untrusteddata) + + + +UserMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#user) + + +## Methods + + +{/*> **goBack**(`payload?`): `Promise`\<`void`\>*/} + +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. + + +CustomOptions}> +[`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CustomOptions) + +Optional custom options to include with the request. + + + +- Returns `Promise`\<`void`\> + + + + +{/*> **selectMfaPushDevice**(`payload`): `Promise`\<`void`\>*/} + +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. + + +SelectMfaPushDeviceOptions}> +[`SelectMfaPushDeviceOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/SelectMfaPushDeviceOptions) + +The options containing the device index. + + + +- Returns `Promise`\<`void`\> + \ 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..fb6a36b0f --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaPushPollingControl.mdx @@ -0,0 +1,133 @@ +--- +title: "MfaPushPollingControl" +--- + +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. + +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. + + + +```ts Example +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; +} +``` + + +## Properties + +{/*> **isRunning**: () => `boolean`*/} + +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. + +- Returns `true` if polling is active and not cancelled. +- Returns `false` if polling has been stopped or has completed. + +< +`boolean` + +```ts Example +if (control.isRunning()) { + console.log('Polling in progress...'); +} else { + console.log('Polling is stopped or completed.'); +} +``` + + + + +{/*> **startPolling**: () => `void`*/} + +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. + +- If polling is already active, calling this again has no effect. +- If previously stopped, calling this restarts the polling loop. + +< +`void` + +```ts Example +control.startPolling(); // Begin checking the MFA push challenge +``` + + + + +{/*> **stopPolling**: () => `void`*/} + +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. + +- Cancels any scheduled timer or pending request. +- Once stopped, `isRunning()` returns `false`. +- Safe to call multiple times; subsequent calls have no effect. + +< +`void` + +```ts Example +const control = mfaPushChallengePush.pollingManager({ intervalMs: 5000 }); +control.startPolling(); + +// Later, if the user cancels: +control.stopPolling(); +``` + + \ 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..6b6271427 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaPushWelcomeMembers.mdx @@ -0,0 +1,131 @@ +--- +title: "MfaPushWelcomeMembers" +--- + +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) + + + +```ts Example +export interface MfaPushWelcomeMembers extends BaseMembers { + screen: ScreenMembersOnMfaPushWelcome; + enroll(payload?: CustomOptions): Promise; + pickAuthenticator(payload?: CustomOptions): Promise; +} +``` + + +- Extends [`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers) + +## Properties + +BrandingMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#branding) + + + +ClientMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#client) + + + +OrganizationMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#organization) + + + +PromptMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#prompt) + + + +ScreenMembersOnMfaPushWelcome}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#screen) + + + +TenantMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#tenant) + + + +TransactionMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#transaction) + + + +UntrustedDataMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#untrusteddata) + + + +UserMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#user) + + +## Methods + + +{/*> **enroll**(`payload?`): `Promise`\<`void`\>*/} + +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) + + +CustomOptions}> +[`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CustomOptions) + + + +- Returns `Promise`\<`void`\> + + + + +{/*> **pickAuthenticator**(`payload?`): `Promise`\<`void`\>*/} + +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) + + +CustomOptions}> +[`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CustomOptions) + + + +- Returns `Promise`\<`void`\> + \ 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..091ec937f --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaRecoveryCodeChallengeContinueOptions.mdx @@ -0,0 +1,30 @@ +--- +title: "MfaRecoveryCodeChallengeContinueOptions" +--- + +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. + + + +```ts Example +export interface ContinueOptions extends CustomOptions { + code: string; +} +``` + + +- Extends [`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CustomOptions) + +## Indexable + +\[`key`: `string`\]: `string` \| `number` \| `boolean` \| `undefined` + +## Properties + + +{/*> **code**: `string`*/} + +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) + \ 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..8359ed82f --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaRecoveryCodeChallengeMembers.mdx @@ -0,0 +1,161 @@ +--- +title: "MfaRecoveryCodeChallengeMembers" +--- + +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. + + + +```ts Example +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; + + /** + * 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; +} +``` + + +- Extends [`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers) + +## Properties + +BrandingMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#branding) + + + +ClientMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#client) + + + +OrganizationMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#organization) + + + +PromptMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#prompt) + + + +ScreenMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#screen) + + + +TenantMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#tenant) + + + +TransactionMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#transaction) + + + +UntrustedDataMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#untrusteddata) + + + +UserMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#user) + + +## Methods + + +{/*> **continue**(`payload`): `Promise`\<`void`\>*/} + +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. + + +MfaRecoveryCodeChallengeContinueOptions}> +[`MfaRecoveryCodeChallengeContinueOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaRecoveryCodeChallengeContinueOptions) + +The continue options containing the recovery code and optional custom options. + + + +- Returns `Promise`\<`void`\> + +A promise that resolves when the continuation is successful. + + + + +{/*> **tryAnotherMethod**(`payload?`): `Promise`\<`void`\>*/} + +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. + + +CustomOptions}> +[`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CustomOptions) + +Optional payload. + + + +- Returns `Promise`\<`void`\> + +A promise that resolves when the navigation is complete. + \ 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..4fe4badbc --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaRecoveryCodeChallengeNewCodeContinueOptions.mdx @@ -0,0 +1,23 @@ +--- +title: "MfaRecoveryCodeChallengeNewCodeContinueOptions" +--- + +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 + + + +```ts Example +export interface ContinueOptions extends CustomOptions { + // No specific properties required beyond CustomOptions. + // The 'saved' parameter is handled internally by the continue method. +} +``` + + +- 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..2dfb9b0f0 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaRecoveryCodeChallengeNewCodeMembers.mdx @@ -0,0 +1,178 @@ +--- +title: "MfaRecoveryCodeChallengeNewCodeMembers" +--- + +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 + + + +```ts Example +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} 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; +} +``` + + +- Extends [`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers) + +## Properties + +BrandingMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#branding) + + + +ClientMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#client) + + + +OrganizationMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#organization) + + + +PromptMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#prompt) + + + +ScreenMembersOnMfaRecoveryCodeChallengeNewCode}> +{/*> **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/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. + +- 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#screen) + + + +TenantMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#tenant) + + + +TransactionMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#transaction) + + + +UntrustedDataMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#untrusteddata) + + + +UserMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#user) + + +## Methods + + +{/*> **continue**(`payload?`): `Promise`\<`void`\>*/} + +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. +It sends a confirmation to the Auth0 server to proceed to the next step. + + +MfaRecoveryCodeChallengeNewCodeContinueOptions}> +[`MfaRecoveryCodeChallengeNewCodeContinueOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/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). + +```typescript Example +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 +} +``` + \ 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..fe056d8d6 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaRecoveryCodeEnrollmentContinueOptions.mdx @@ -0,0 +1,28 @@ +--- +title: "MfaRecoveryCodeEnrollmentContinueOptions" +--- + +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) + + + +```ts Example +export interface MfaRecoveryCodeEnrollmentContinueOptions extends CustomOptions { + isCodeCopied: boolean; +} +``` + + +- Extends [`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CustomOptions) + +## Indexable + +\[`key`: `string`\]: `string` \| `number` \| `boolean` \| `undefined` + +## Properties + + +{/*> **isCodeCopied**: `boolean`*/} + +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) + \ 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..af9ac1a63 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaRecoveryCodeEnrollmentMembers.mdx @@ -0,0 +1,137 @@ +--- +title: "MfaRecoveryCodeEnrollmentMembers" +--- + +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. + + + +```ts Example +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} A promise that resolves when the action is successfully submitted. + * Rejects with an error if the submission fails. + */ + continue(payload: MfaRecoveryCodeEnrollmentContinueOptions): Promise; +} +``` + + +- Extends [`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers) + +## Properties + +BrandingMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#branding) + + + +ClientMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#client) + + + +OrganizationMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#organization) + + + +PromptMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#prompt) + + + +ScreenMembersOnMfaRecoveryCodeEnrollment}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#screen) + + + +TenantMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#tenant) + + + +TransactionMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#transaction) + + + +UntrustedDataMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#untrusteddata) + + + +UserMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#user) + + +## Methods + + +{/*> **continue**(`payload`): `Promise`\<`void`\>*/} + +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. +It redirects to the next screen in the authentication flow. + + +MfaRecoveryCodeEnrollmentContinueOptions}> +[`MfaRecoveryCodeEnrollmentContinueOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/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. + \ 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..9146f7350 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaSmsChallengeMembers.mdx @@ -0,0 +1,204 @@ +--- +title: "MfaSmsChallengeMembers" +--- + +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) + + + +```ts Example +export interface MfaSmsChallengeMembers extends BaseMembers { + screen: ScreenMembersOnMfaSmsChallenge; + untrustedData: UntrustedDataMembersOnMfaSmsChallenge; + continueMfaSmsChallenge(payload: MfaSmsChallengeOptions): Promise; + pickSms(payload?: CustomOptions): Promise; + resendCode(payload?: CustomOptions): Promise; + tryAnotherMethod(payload?: CustomOptions): Promise; + getACall(payload?: CustomOptions): Promise; + /** + * Gets resend functionality with timeout management for this screen + * @param options Configuration options for resend functionality + */ + resendManager(options?: StartResendOptions): ResendControl; +} +``` + + +- Extends [`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers) + +## Properties + +BrandingMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#branding) + + + +ClientMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#client) + + + +OrganizationMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#organization) + + + +PromptMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#prompt) + + + +ScreenMembersOnMfaSmsChallenge}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#screen) + + + +TenantMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#tenant) + + + +TransactionMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#transaction) + + + +UntrustedDataMembersOnMfaSmsChallenge}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#untrusteddata) + + + +UserMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#user) + + +## Methods + + +{/*> **continueMfaSmsChallenge**(`payload`): `Promise`\<`void`\>*/} + +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) + + +MfaSmsChallengeOptions}> +[`MfaSmsChallengeOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaSmsChallengeOptions) + + + +- Returns `Promise`\<`void`\> + + + + +{/*> **getACall**(`payload?`): `Promise`\<`void`\>*/} + +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) + + +CustomOptions}> +[`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CustomOptions) + + + +- Returns `Promise`\<`void`\> + + + + +{/*> **pickSms**(`payload?`): `Promise`\<`void`\>*/} + +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) + + +CustomOptions}> +[`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CustomOptions) + + + +- Returns `Promise`\<`void`\> + + + + +{/*> **resendCode**(`payload?`): `Promise`\<`void`\>*/} + +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) + + +CustomOptions}> +[`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CustomOptions) + + + +- Returns `Promise`\<`void`\> + + + +ResendControl}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/mfa-sms-challenge.ts#L45) + +Gets resend functionality with timeout management for this screen + + +StartResendOptions}> +[`StartResendOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/StartResendOptions) + +Configuration options for resend functionality + + + +- Returns [`ResendControl`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResendControl) + + + + +{/*> **tryAnotherMethod**(`payload?`): `Promise`\<`void`\>*/} + +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) + + +CustomOptions}> +[`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CustomOptions) + + + +- Returns `Promise`\<`void`\> + \ 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..315c8aa4b --- /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/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/mfa-sms-challenge.ts#L7) + + + +```ts Example +export interface MfaSmsChallengeOptions { + code: string; + rememberDevice?: boolean; + [key: string]: string | number | boolean | undefined; +} +``` + + +## Indexable + +\[`key`: `string`\]: `string` \| `number` \| `boolean` \| `undefined` + +## Properties + + +{/*> **code**: `string`*/} + +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) + + + + +{/*> `optional` **rememberDevice**: `boolean`*/} + +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) + \ 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..2d8b187b6 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaSmsEnrollmentMembers.mdx @@ -0,0 +1,153 @@ +--- +title: "MfaSmsEnrollmentMembers" +--- + +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) + + + +```ts Example +export interface MfaSmsEnrollmentMembers extends BaseMembers { + screen: ScreenMembersOnMfaSmsEnrollment; + pickCountryCode(payload?: CustomOptions): Promise; + continueEnrollment(payload: { phone: string; captcha?: string }): Promise; + tryAnotherMethod(payload?: CustomOptions): Promise; +} +``` + + +- Extends [`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers) + +## Properties + +BrandingMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#branding) + + + +ClientMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#client) + + + +OrganizationMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#organization) + + + +PromptMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#prompt) + + + +ScreenMembersOnMfaSmsEnrollment}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#screen) + + + +TenantMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#tenant) + + + +TransactionMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#transaction) + + + +UntrustedDataMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#untrusteddata) + + + +UserMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#user) + + +## Methods + + +{/*> **continueEnrollment**(`payload`): `Promise`\<`void`\>*/} + +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) + + + +###### captcha? + +`string` + +###### phone + +`string` + + + +- Returns `Promise`\<`void`\> + + + + +{/*> **pickCountryCode**(`payload?`): `Promise`\<`void`\>*/} + +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) + + +CustomOptions}> +[`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CustomOptions) + + + +- Returns `Promise`\<`void`\> + + + + +{/*> **tryAnotherMethod**(`payload?`): `Promise`\<`void`\>*/} + +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) + + +CustomOptions}> +[`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CustomOptions) + + + +- Returns `Promise`\<`void`\> + \ 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..9015f0dbb --- /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/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/mfa-sms-enrollment.ts#L5) + + + +```ts Example +export interface MfaSmsEnrollmentOptions { + phone?: string; + captcha?: string; + [key: string]: string | number | boolean | undefined; +} +``` + + +## Indexable + +\[`key`: `string`\]: `string` \| `number` \| `boolean` \| `undefined` + +## Properties + + +{/*> `optional` **captcha**: `string`*/} + +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) + + + + +{/*> `optional` **phone**: `string`*/} + +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) + \ 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..7a7b290fd --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaSmsListMembers.mdx @@ -0,0 +1,156 @@ +--- +title: "MfaSmsListMembers" +--- + +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. + + + +```ts Example +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} + * @throws {Error} If the index is out of bounds. + */ + selectPhoneNumber(payload?: MfaSmsListOptions): Promise; + /** + * Navigates back to the previous screen. + * @param {MfaSmsListOptions} [payload] - Optional payload for the action. + * @returns {Promise} + */ + backAction(payload?: CustomOptions): Promise; +} +``` + + +- Extends [`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers) + +## Properties + +BrandingMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#branding) + + + +ClientMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#client) + + + +OrganizationMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#organization) + + + +PromptMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#prompt) + + + +ScreenMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#screen) + + + +TenantMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#tenant) + + + +TransactionMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#transaction) + + + +UntrustedDataMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#untrusteddata) + + + +UserMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#user) + + +## Methods + + +{/*> **backAction**(`payload?`): `Promise`\<`void`\>*/} + +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. + + +CustomOptions}> +[`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CustomOptions) + +Optional payload for the action. + + + +- Returns `Promise`\<`void`\> + + + + +{/*> **selectPhoneNumber**(`payload?`): `Promise`\<`void`\>*/} + +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. + + +MfaSmsListOptions}> +[`MfaSmsListOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaSmsListOptions) + +Optional payload for the action. + + + +- Returns `Promise`\<`void`\> + +#### Throws + +If the index is out of bounds. + \ 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..0a41d506e --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaSmsListOptions.mdx @@ -0,0 +1,38 @@ +--- +title: "MfaSmsListOptions" +--- + +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. + + + +```ts Example +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; +} +``` + + +## Indexable + +\[`key`: `string`\]: `string` \| `number` \| `boolean` \| `undefined` + +Any additional custom options + +## Properties + + +{/*> **index**: `number`*/} + +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) + +The index of the phone number to select. + \ 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..3813167b6 --- /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/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/mfa-voice-challenge.ts#L10) + +Options for submitting the voice challenge code. + + + +```ts Example +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; +} +``` + + +## Indexable + +\[`key`: `string`\]: `string` \| `number` \| `boolean` \| `undefined` + +Additional custom options to pass with the request. + +## Properties + + +{/*> **code**: `string`*/} + +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. + + + + +{/*> `optional` **rememberDevice**: `boolean`*/} + +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. + \ 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..df1252d52 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaVoiceChallengeMembers.mdx @@ -0,0 +1,339 @@ +--- +title: "MfaVoiceChallengeMembers" +--- + +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. + + + +```ts Example +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; + + /** + * 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; + + /** + * 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; + + /** + * 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; + + /** + * 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; + + /** + * Gets resend functionality with timeout management for this screen + * @param options Configuration options for resend functionality + */ + resendManager(options?: StartResendOptions): ResendControl; +} +``` + + +- Extends [`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers) + +## Properties + +BrandingMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#branding) + + + +ClientMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#client) + + + +OrganizationMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#organization) + + + +PromptMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#prompt) + + + +ScreenMembersOnMfaVoiceChallenge}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#screen) + + + +TenantMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#tenant) + + + +TransactionMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#transaction) + + + +UntrustedDataMembersOnMfaVoiceChallenge}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#untrusteddata) + + + +UserMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#user) + + +## Methods + + +{/*> **continue**(`payload`): `Promise`\<`void`\>*/} + +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. + + +MfaVoiceChallengeContinueOptions}> +[`MfaVoiceChallengeContinueOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaVoiceChallengeContinueOptions) + +Object containing the verification code and optional parameters + + + +- Returns `Promise`\<`void`\> + +Promise that resolves when the code is successfully validated + +```typescript Example +const mfaVoiceChallenge = new MfaVoiceChallenge(); +mfaVoiceChallenge.continue({ + code: '123456', + rememberDevice: true +}); +``` + + + + +{/*> **pickPhone**(`payload?`): `Promise`\<`void`\>*/} + +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. + + +CustomOptions}> +[`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CustomOptions) + +Optional custom parameters + + + +- Returns `Promise`\<`void`\> + +Promise that resolves when navigation is complete + +```typescript Example +const mfaVoiceChallenge = new MfaVoiceChallenge(); +mfaVoiceChallenge.pickPhone(); +``` + + + + +{/*> **resendCode**(`payload?`): `Promise`\<`void`\>*/} + +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. + + +CustomOptions}> +[`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CustomOptions) + +Optional custom parameters + + + +- Returns `Promise`\<`void`\> + +Promise that resolves when the new code is sent + +```typescript Example +const mfaVoiceChallenge = new MfaVoiceChallenge(); +mfaVoiceChallenge.resendCode(); +``` + + + +ResendControl}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/mfa-voice-challenge.ts#L140) + +Gets resend functionality with timeout management for this screen + + +StartResendOptions}> +[`StartResendOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/StartResendOptions) + +Configuration options for resend functionality + + + +- Returns [`ResendControl`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResendControl) + + + + +{/*> **switchToSms**(`payload?`): `Promise`\<`void`\>*/} + +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. + + +CustomOptions}> +[`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CustomOptions) + +Optional custom parameters + + + +- Returns `Promise`\<`void`\> + +Promise that resolves when switching is complete + +```typescript Example +const mfaVoiceChallenge = new MfaVoiceChallenge(); +mfaVoiceChallenge.switchToSms(); +``` + + + + +{/*> **tryAnotherMethod**(`payload?`): `Promise`\<`void`\>*/} + +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. + + +CustomOptions}> +[`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CustomOptions) + +Optional custom parameters + + + +- Returns `Promise`\<`void`\> + +Promise that resolves when navigation is complete + +```typescript Example +const mfaVoiceChallenge = new MfaVoiceChallenge(); +mfaVoiceChallenge.tryAnotherMethod(); +``` + \ 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..eb9388b22 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaVoiceEnrollmentContinueOptions.mdx @@ -0,0 +1,30 @@ +--- +title: "MfaVoiceEnrollmentContinueOptions" +--- + +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. + + + +```ts Example +export interface ContinueOptions extends CustomOptions { + phone: string; +} +``` + + +- Extends [`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CustomOptions) + +## Indexable + +\[`key`: `string`\]: `string` \| `number` \| `boolean` \| `undefined` + +## Properties + + +{/*> **phone**: `string`*/} + +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) + \ 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..f8b0e6aa7 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaVoiceEnrollmentMembers.mdx @@ -0,0 +1,189 @@ +--- +title: "MfaVoiceEnrollmentMembers" +--- + +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. + + + +```ts Example +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; + + /** + * Allows trying another authentication method. + * @param payload - Optional custom options. + * @returns Promise that resolves when the user switches method. + */ + tryAnotherMethod(payload?: CustomOptions): Promise; + + /** + * 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; +} +``` + + +- Extends [`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers) + +## Properties + +BrandingMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#branding) + + + +ClientMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#client) + + + +OrganizationMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#organization) + + + +PromptMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#prompt) + + + +ScreenMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#screen) + + + +TenantMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#tenant) + + + +TransactionMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#transaction) + + + +UntrustedDataMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#untrusteddata) + + + +UserMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#user) + + +## Methods + + +{/*> **continue**(`payload`): `Promise`\<`void`\>*/} + +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. + + +MfaVoiceEnrollmentContinueOptions}> +[`MfaVoiceEnrollmentContinueOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaVoiceEnrollmentContinueOptions) + +The phone number and optional custom options. + + + +- Returns `Promise`\<`void`\> + +Promise that resolves when enrollment continues. + + + + +{/*> **selectPhoneCountryCode**(`payload?`): `Promise`\<`void`\>*/} + +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. + + +CustomOptions}> +[`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CustomOptions) + +Optional custom options. + + + +- Returns `Promise`\<`void`\> + +Promise that resolves when the country code is selected. + + + + +{/*> **tryAnotherMethod**(`payload?`): `Promise`\<`void`\>*/} + +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. + + +CustomOptions}> +[`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CustomOptions) + +Optional custom options. + + + +- Returns `Promise`\<`void`\> + +Promise that resolves when the user switches method. + \ 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..5200d08c5 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaWebAuthnChangeKeyNicknameContinueOptions.mdx @@ -0,0 +1,42 @@ +--- +title: "MfaWebAuthnChangeKeyNicknameContinueOptions" +--- + +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 + + + +```ts Example +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; +} +``` + + +- Extends [`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CustomOptions) + +## Indexable + +\[`key`: `string`\]: `string` \| `number` \| `boolean` \| `undefined` + +## Properties + + +{/*> **nickname**: `string`*/} + +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. + It must adhere to length and character constraints defined by the server. + \ 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..a3728158f --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaWebAuthnChangeKeyNicknameMembers.mdx @@ -0,0 +1,211 @@ +--- +title: "MfaWebAuthnChangeKeyNicknameMembers" +--- + +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 + + + +```ts Example +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} 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; +} +``` + + +- Extends [`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers) + +## Properties + +BrandingMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#branding) + + + +ClientMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#client) + + + +OrganizationMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#organization) + + + +PromptMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#prompt) + + + +ScreenMembersOnMfaWebAuthnChangeKeyNickname}> +{/*> **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/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. + +- 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#screen) + + + +TenantMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#tenant) + + + +TransactionMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#transaction) + + + +UntrustedDataMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#untrusteddata) + + + +UserMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#user) + + +## Methods + + +{/*> **continueWithNewNickname**(`payload`): `Promise`\<`void`\>*/} + +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. +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. + + +MfaWebAuthnChangeKeyNicknameContinueOptions}> +[`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. + + + +- 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. + +```typescript Example +// 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" + } + }); +} +``` + \ 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..8d24cf4b0 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaWebAuthnEnrollmentSuccessMembers.mdx @@ -0,0 +1,172 @@ +--- +title: "MfaWebAuthnEnrollmentSuccessMembers" +--- + +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 + + + +```ts Example +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} 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; +} +``` + + +- Extends [`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers) + +## Properties + +BrandingMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#branding) + + + +ClientMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#client) + + + +OrganizationMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#organization) + + + +PromptMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#prompt) + + + +ScreenMembersOnMfaWebAuthnEnrollmentSuccess}> +{/*> **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/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`. + +- 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#screen) + + + +TenantMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#tenant) + + + +TransactionMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#transaction) + + + +UntrustedDataMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#untrusteddata) + + + +UserMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#user) + + +## Methods + + +{/*> **continue**(`payload?`): `Promise`\<`void`\>*/} + +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"`. + + +WebAuthnEnrollSuccessContinueOptions}> +[`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. + + + +- 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). + +```typescript Example +// 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. +} +``` + \ 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..6200b2623 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaWebAuthnErrorMembers.mdx @@ -0,0 +1,290 @@ +--- +title: "MfaWebAuthnErrorMembers" +--- + +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 + + + +```ts Example +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} 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; + + /** + * 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} 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; + + /** + * 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} 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; + + /** + * 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} 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; +} +``` + + +- Extends [`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers) + +## Properties + +BrandingMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#branding) + + + +ClientMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#client) + + + +OrganizationMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#organization) + + + +PromptMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#prompt) + + + +ScreenMembersOnMfaWebAuthnError}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#screen) + + + +TenantMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#tenant) + + + +TransactionMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#transaction) + + + +UntrustedDataMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#untrusteddata) + + + +UserMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#user) + + +## Methods + + +{/*> **noThanks**(`payload?`): `Promise`\<`void`\>*/} + +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. + + +CustomOptions}> +[`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/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. + +```typescript Example +// Assuming 'sdk' is an instance of MfaWebAuthnError +await sdk.noThanks(); +``` + + + + +{/*> **tryAgain**(`payload?`): `Promise`\<`void`\>*/} + +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. + + +CustomOptions}> +[`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/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. + +```typescript Example +// Assuming 'sdk' is an instance of MfaWebAuthnError +await sdk.tryAgain(); +``` + + + + +{/*> **tryAnotherMethod**(`payload?`): `Promise`\<`void`\>*/} + +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. + + +CustomOptions}> +[`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/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. + +```typescript Example +// Assuming 'sdk' is an instance of MfaWebAuthnError +await sdk.tryAnotherMethod(); +``` + + + + +{/*> **usePassword**(`payload?`): `Promise`\<`void`\>*/} + +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. + + +CustomOptions}> +[`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/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. + +```typescript Example +// Assuming 'sdk' is an instance of MfaWebAuthnError +await sdk.usePassword(); +``` + \ 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..1433b9c42 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaWebAuthnNotAvailableErrorMembers.mdx @@ -0,0 +1,159 @@ +--- +title: "MfaWebAuthnNotAvailableErrorMembers" +--- + +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 + + + +```ts Example +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} 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; +} +``` + + +- Extends [`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers) + +## Properties + +BrandingMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#branding) + + + +ClientMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#client) + + + +OrganizationMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#organization) + + + +PromptMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#prompt) + + + +ScreenMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#screen) + + + +TenantMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#tenant) + + + +TransactionMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#transaction) + + + +UntrustedDataMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#untrusteddata) + + + +UserMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#user) + + +## Methods + + +{/*> **tryAnotherMethod**(`payload?`): `Promise`\<`void`\>*/} + +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 +from other available/enrolled MFA factors. + + +CustomOptions}> +[`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/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). + +```typescript Example +// 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. +} +``` + \ 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..c7cf94fa8 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaWebAuthnPlatformChallengeMembers.mdx @@ -0,0 +1,322 @@ +--- +title: "MfaWebAuthnPlatformChallengeMembers" +--- + +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 + + + +```ts Example +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} 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; + + /** + * 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} 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; + + /** + * 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} 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; +} +``` + + +- Extends [`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers) + +## Properties + +BrandingMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#branding) + + + +ClientMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#client) + + + +OrganizationMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#organization) + + + +PromptMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#prompt) + + + +ScreenMembersOnMfaWebAuthnPlatformChallenge}> +{/*> **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/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. + +- 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#screen) + + + +TenantMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#tenant) + + + +TransactionMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#transaction) + + + +UntrustedDataMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#untrusteddata) + + + +UserMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#user) + + +## Methods + + +{/*> **reportBrowserError**(`options`): `Promise`\<`void`\>*/} + +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 +a browser-side WebAuthn issue (e.g., user cancellation `NotAllowedError`, timeout). +It submits the error details with `action: "showError::{errorDetailsJsonString}"` and an empty `response`. + + +MfaWebAuthnPlatformChallengeReportErrorOptions}> +[`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. + + + +- 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). + +```typescript Example +// 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); +} +``` + + + + +{/*> **tryAnotherMethod**(`options?`): `Promise`\<`void`\>*/} + +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 +the user to an MFA factor selection screen. + + +MfaWebAuthnPlatformChallengeTryAnotherMethodOptions}> +[`MfaWebAuthnPlatformChallengeTryAnotherMethodOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/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. + +```typescript Example +// 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); +} +``` + + + + +{/*> **verify**(`options?`): `Promise`\<`void`\>*/} + +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 +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. + + +VerifyPlatformAuthenticatorOptions}> +[`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. + + + +- 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. + +```typescript Example +// 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. +} +``` + \ 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..bc0dcd83d --- /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/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/mfa-webauthn-platform-challenge.ts#L56) + +ReportBrowserErrorOptions + + + +```ts Example +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; +} +``` + + +## Properties + +WebAuthnErrorDetails}> +{/*> **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/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. + \ 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..b59763bb6 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaWebAuthnPlatformChallengeTryAnotherMethodOptions.mdx @@ -0,0 +1,20 @@ +--- +title: "MfaWebAuthnPlatformChallengeTryAnotherMethodOptions" +--- + +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 + + + +```ts Example +export interface TryAnotherMethodOptions extends CustomOptions {} +``` + + +- 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..7c341c3b3 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaWebAuthnPlatformEnrollmentMembers.mdx @@ -0,0 +1,298 @@ +--- +title: "MfaWebAuthnPlatformEnrollmentMembers" +--- + +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 + + + +```ts Example +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} 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; + + /** + * 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} 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 + * } +``` + + +- Extends [`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers) + +## Properties + +BrandingMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#branding) + + + +ClientMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#client) + + + +OrganizationMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#organization) + + + +PromptMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#prompt) + + + +ScreenMembersOnMfaWebAuthnPlatformEnrollment}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#screen) + + + +TenantMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#tenant) + + + +TransactionMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#transaction) + + + +UntrustedDataMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#untrusteddata) + + + +UserMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#user) + + +## Methods + + +{/*> **refuseEnrollmentOnThisDevice**(`payload?`): `Promise`\<`void`\>*/} + +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. + + +CustomOptions}> +[`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/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. + +```typescript Example +// Assuming 'sdk' is an instance of MfaWebAuthnPlatformEnrollment +await sdk.refuseEnrollmentOnThisDevice(); +``` + + + + +{/*> **reportBrowserError**(`payload`): `Promise`\<`void`\>*/} + +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. + + +ReportBrowserErrorOptions}> +[`ReportBrowserErrorOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/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. + +```typescript Example +// 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 +} +``` + + + + +{/*> **snoozeEnrollment**(`payload?`): `Promise`\<`void`\>*/} + +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. + + +CustomOptions}> +[`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/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. + +```typescript Example +// Assuming 'sdk' is an instance of MfaWebAuthnPlatformEnrollment +await sdk.snoozeEnrollment(); +``` + + + + +{/*> **submitPasskeyCredential**(`payload?`): `Promise`\<`void`\>*/} + +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. +This method internally calls `createPasskeyCredentials` (which wraps `navigator.credentials.create()`). + + +SubmitPasskeyCredentialOptions}> +[`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. + + + +- 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. + +```typescript Example +// 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 } }); + } +} +``` + \ 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..a54f25c8c --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaWebAuthnRoamingChallengeMembers.mdx @@ -0,0 +1,308 @@ +--- +title: "MfaWebAuthnRoamingChallengeMembers" +--- + +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 + + + +```ts Example +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} 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; + + /** + * 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} 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; + + /** + * 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} 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; +} +``` + + +- Extends [`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers) + +## Properties + +BrandingMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#branding) + + + +ClientMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#client) + + + +OrganizationMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#organization) + + + +PromptMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#prompt) + + + +ScreenMembersOnMfaWebAuthnRoamingChallenge}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#screen) + + + +TenantMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#tenant) + + + +TransactionMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#transaction) + + + +UntrustedDataMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#untrusteddata) + + + +UserMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#user) + + +## Methods + + +{/*> **reportWebAuthnError**(`options`): `Promise`\<`void`\>*/} + +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 +`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}"`. + + +MfaWebAuthnRoamingChallengeReportErrorOptions}> +[`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. + + + +- Returns `Promise`\<`void`\> + +A promise that resolves when the error report is submitted. + +#### Throws + +Throws an error if the form submission fails. + +```typescript Example +// 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); +} +``` + + + + +{/*> **tryAnotherMethod**(`options?`): `Promise`\<`void`\>*/} + +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 +the user to an MFA factor selection screen. + + +MfaWebAuthnRoamingChallengeTryAnotherMethodOptions}> +[`MfaWebAuthnRoamingChallengeTryAnotherMethodOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/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. + +```typescript Example +// 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); +} +``` + + + + +{/*> **verify**(`options?`): `Promise`\<`void`\>*/} + +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`. +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. + + +VerifySecurityKeyOptions}> +[`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. + + + +- 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. + +```typescript Example +// 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. +} +``` + \ 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..a5d135487 --- /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/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/mfa-webauthn-roaming-challenge.ts#L42) + +ReportWebAuthnErrorOptions + + + +```ts Example +export interface ReportWebAuthnErrorOptions { + error: WebAuthnErrorDetails; +} +``` + + +## Properties + +WebAuthnErrorDetails}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/mfa-webauthn-roaming-challenge.ts#L43) + +The error object from the WebAuthn API to be reported. + \ 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..a3ea5e02d --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaWebAuthnRoamingChallengeTryAnotherMethodOptions.mdx @@ -0,0 +1,20 @@ +--- +title: "MfaWebAuthnRoamingChallengeTryAnotherMethodOptions" +--- + +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 + + + +```ts Example +export interface TryAnotherMethodOptions extends CustomOptions {} +``` + + +- 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..545c99d09 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaWebAuthnRoamingEnrollmentMembers.mdx @@ -0,0 +1,263 @@ +--- +title: "MfaWebAuthnRoamingEnrollmentMembers" +--- + +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. + + + +```ts Example +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; + /** + * 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; + /** + * 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; +} +``` + + +- Extends [`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers) + +## Properties + +BrandingMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#branding) + + + +ClientMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#client) + + + +OrganizationMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#organization) + + + +PromptMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#prompt) + + + +ScreenMembersOnMfaWebAuthnRoamingEnrollment}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#screen) + + + +TenantMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#tenant) + + + +TransactionMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#transaction) + + + +UntrustedDataMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#untrusteddata) + + + +UserMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#user) + + +## Methods + + +{/*> **enroll**(`payload`): `Promise`\<`void`\>*/} + +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. + + +CustomOptions}> +[`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CustomOptions) + +Optional custom options to include with the request. + + + +- Returns `Promise`\<`void`\> + +```typescript Example +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 } }); +} +``` + + + + +{/*> **showError**(`payload`): `Promise`\<`void`\>*/} + +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. + + +ShowErrorOptions}> +[`ShowErrorOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ShowErrorOptions) + +The options containing the error details. + + + +- Returns `Promise`\<`void`\> + +```typescript Example +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 +``` + + + + +{/*> **tryAnotherMethod**(`payload?`): `Promise`\<`void`\>*/} + +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. + + +MfaWebAuthnRoamingEnrollmentTryAnotherMethodOptions}> +[`MfaWebAuthnRoamingEnrollmentTryAnotherMethodOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaWebAuthnRoamingEnrollmentTryAnotherMethodOptions) + +Optional custom options to include with the request. + + + +- Returns `Promise`\<`void`\> + +```typescript Example +import MfaWebAuthnRoamingEnrollment from '@auth0/auth0-acul-js/mfa-webauthn-roaming-enrollment'; + +const webauthnEnrollment = new MfaWebAuthnRoamingEnrollment(); +await webauthnEnrollment.tryAnotherMethod(); +``` + \ 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..4a865ad1e --- /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/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/mfa-webauthn-roaming-enrollment.ts#L27) + +Options for trying another MFA method. + + + +```ts Example +export interface TryAnotherMethodOptions { + /** + * Any additional custom options. + */ + [key: string]: string | number | boolean | undefined; +} +``` + + +## 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..70e64b09c --- /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/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/organization.ts#L26) + + + +```ts Example +export interface OrganizationMembers { + id: string | null; + name: string | null; + usage: string | null; + displayName: string | null; + branding: Branding | null; + metadata: { [key: string]: string } | null; +} +``` + + +## Properties + +Branding}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/organization.ts#L31) + + + + +{/*> **displayName**: `string` \| `null`*/} + +Defined in: [interfaces/models/organization.ts:30](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/organization.ts#L30) + + + + +{/*> **id**: `string` \| `null`*/} + +Defined in: [interfaces/models/organization.ts:27](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/organization.ts#L27) + + + + +{/*> **metadata**: \{\[`key`: `string`\]: `string`; \} \| `null`*/} + +Defined in: [interfaces/models/organization.ts:32](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/organization.ts#L32) + + + + +{/*> **name**: `string` \| `null`*/} + +Defined in: [interfaces/models/organization.ts:28](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/organization.ts#L28) + + + + +{/*> **usage**: `string` \| `null`*/} + +Defined in: [interfaces/models/organization.ts:29](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/organization.ts#L29) + \ 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..feaf8f3b6 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationPickerMembers.mdx @@ -0,0 +1,155 @@ +--- +title: "OrganizationPickerMembers" +--- + +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 + + + +```ts Example +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; + + /** + * 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; +} +``` + + +- Extends [`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers) + +## Properties + +BrandingMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#branding) + + + +ClientMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#client) + + + +OrganizationMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#organization) + + + +PromptMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#prompt) + + + +ScreenMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#screen) + + + +TenantMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#tenant) + + + +TransactionMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#transaction) + + + +UntrustedDataMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#untrusteddata) + + + +UserMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#user) + + +## Methods + + +{/*> **selectOrganization**(`payload`): `Promise`\<`void`\>*/} + +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. + + + +The options containing the organization ID. + +###### organization + +`string` + +###### state + +`string` + + + +- Returns `Promise`\<`void`\> + + + + +{/*> **skipOrganizationSelection**(`payload?`): `Promise`\<`void`\>*/} + +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. + + +CustomOptions}> +[`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CustomOptions) + +Optional custom options to include with the request. + + + +- Returns `Promise`\<`void`\> + \ 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..a6148751a --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationSelectionMembers.mdx @@ -0,0 +1,130 @@ +--- +title: "OrganizationSelectionMembers" +--- + +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. + + + +```ts Example +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; +} +``` + + +- Extends [`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers) + +## Properties + +BrandingMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#branding) + + + +ClientMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#client) + + + +OrganizationMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#organization) + + + +PromptMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#prompt) + + + +ScreenMembersOnOrganizationSelection}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#screen) + + + +TenantMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#tenant) + + + +TransactionMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#transaction) + + + +UntrustedDataMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#untrusteddata) + + + +UserMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#user) + + +## Methods + + +{/*> **continueWithOrganizationName**(`payload`): `Promise`\<`void`\>*/} + +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. + + +ContinueWithOrganizationNameOptions}> +[`ContinueWithOrganizationNameOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ContinueWithOrganizationNameOptions) + +The options containing the organization name. + + + +- Returns `Promise`\<`void`\> + \ 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..ef10e4178 --- /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/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/user.ts#L32) + + + +```ts Example +export interface Organizations { + organizationId: string | undefined; + organizationName: string | undefined; + displayName: string | undefined; + branding: Branding; +} +``` + + +## Properties + +Branding}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/user.ts#L36) + + + + +{/*> **displayName**: `string` \| `undefined`*/} + +Defined in: [interfaces/models/user.ts:35](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/user.ts#L35) + + + + +{/*> **organizationId**: `string` \| `undefined`*/} + +Defined in: [interfaces/models/user.ts:33](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/user.ts#L33) + + + + +{/*> **organizationName**: `string` \| `undefined`*/} + +Defined in: [interfaces/models/user.ts:34](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/user.ts#L34) + \ 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..e03998a7d --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OtpCodeOptions.mdx @@ -0,0 +1,33 @@ +--- +title: "OtpCodeOptions" +--- + +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) + + + +```ts Example +export interface OtpCodeOptions extends CustomOptions { + /** + * The OTP code that the user enters to submit. + */ + code: string; +} +``` + + +- Extends [`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CustomOptions) + +## Indexable + +\[`key`: `string`\]: `string` \| `number` \| `boolean` \| `undefined` + +## Properties + + +{/*> **code**: `string`*/} + +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. + \ 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..7cfa5b90e --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PasskeyCreate.mdx @@ -0,0 +1,96 @@ +--- +title: "PasskeyCreate" +--- + +Defined in: [interfaces/models/screen.ts:23](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/screen.ts#L23) + + + +```ts Example +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; + }; + }; +} +``` + + +## Properties + +### public\_key + +> **public\_key**: `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) + + +{/*> **authenticatorSelection**: `object`*/} + +##### authenticatorSelection.authenticatorAttachment? + +{/*> `optional` **authenticatorAttachment**: `string`*/} + +##### authenticatorSelection.residentKey + +{/*> **residentKey**: `string`*/} + +##### authenticatorSelection.userVerification + +{/*> **userVerification**: `string`*/} + +#### challenge + +{/*> **challenge**: `string`*/} + +#### pubKeyCredParams + +{/*> **pubKeyCredParams**: \[\{ `alg`: `number`; `type`: `string`; \}\]*/} + +#### rp + +{/*> **rp**: `object`*/} + +##### rp.id + +{/*> **id**: `string`*/} + +##### rp.name + +{/*> **name**: `string`*/} + +#### user + +{/*> **user**: `object`*/} + +##### user.displayName + +{/*> **displayName**: `string`*/} + +##### user.id + +{/*> **id**: `string`*/} + +##### user.name + +{/*> **name**: `string`*/} + \ 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..3065ca232 --- /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/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/utils/passkeys.ts#L21) + + + +```ts Example +export interface PasskeyCreateResponse { + id: string; + rawId: string | null; + type: string; + authenticatorAttachment: string | null; + response: CredentialResponse; +} +``` + + +## Properties + + +{/*> **authenticatorAttachment**: `string` \| `null`*/} + +Defined in: [interfaces/utils/passkeys.ts:25](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/utils/passkeys.ts#L25) + + + + +{/*> **id**: `string`*/} + +Defined in: [interfaces/utils/passkeys.ts:22](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/utils/passkeys.ts#L22) + + + + +{/*> **rawId**: `string` \| `null`*/} + +Defined in: [interfaces/utils/passkeys.ts:23](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/utils/passkeys.ts#L23) + + + +CredentialResponse}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/utils/passkeys.ts#L26) + + + + +{/*> **type**: `string`*/} + +Defined in: [interfaces/utils/passkeys.ts:24](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/utils/passkeys.ts#L24) + \ 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..9647e5f1d --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PasskeyEnrollmentLocalMembers.mdx @@ -0,0 +1,131 @@ +--- +title: "PasskeyEnrollmentLocalMembers" +--- + +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) + + + +```ts Example +export interface PasskeyEnrollmentLocalMembers extends BaseMembers { + screen: ScreenMembersOnPasskeyEnrollmentLocal; + continuePasskeyEnrollment(payload?: CustomOptions): Promise; + abortPasskeyEnrollment(payload: AbortEnrollmentOptions): Promise; +} +``` + + +- Extends [`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers) + +## Properties + +BrandingMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#branding) + + + +ClientMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#client) + + + +OrganizationMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#organization) + + + +PromptMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#prompt) + + + +ScreenMembersOnPasskeyEnrollmentLocal}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#screen) + + + +TenantMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#tenant) + + + +TransactionMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#transaction) + + + +UntrustedDataMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#untrusteddata) + + + +UserMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#user) + + +## Methods + + +{/*> **abortPasskeyEnrollment**(`payload`): `Promise`\<`void`\>*/} + +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) + + +AbortEnrollmentOptions}> +[`AbortEnrollmentOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/AbortEnrollmentOptions) + + + +- Returns `Promise`\<`void`\> + + + + +{/*> **continuePasskeyEnrollment**(`payload?`): `Promise`\<`void`\>*/} + +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) + + +CustomOptions}> +[`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CustomOptions) + + + +- Returns `Promise`\<`void`\> + \ 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..ea54cd6d3 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PasskeyEnrollmentMembers.mdx @@ -0,0 +1,131 @@ +--- +title: "PasskeyEnrollmentMembers" +--- + +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) + + + +```ts Example +export interface PasskeyEnrollmentMembers extends BaseMembers { + screen: ScreenMembersOnPasskeyEnrollment; + continuePasskeyEnrollment(payload?: CustomOptions): Promise; + abortPasskeyEnrollment(payload?: CustomOptions): Promise; +} +``` + + +- Extends [`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers) + +## Properties + +BrandingMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#branding) + + + +ClientMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#client) + + + +OrganizationMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#organization) + + + +PromptMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#prompt) + + + +ScreenMembersOnPasskeyEnrollment}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#screen) + + + +TenantMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#tenant) + + + +TransactionMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#transaction) + + + +UntrustedDataMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#untrusteddata) + + + +UserMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#user) + + +## Methods + + +{/*> **abortPasskeyEnrollment**(`payload?`): `Promise`\<`void`\>*/} + +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) + + +CustomOptions}> +[`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CustomOptions) + + + +- Returns `Promise`\<`void`\> + + + + +{/*> **continuePasskeyEnrollment**(`payload?`): `Promise`\<`void`\>*/} + +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) + + +CustomOptions}> +[`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CustomOptions) + + + +- Returns `Promise`\<`void`\> + \ 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..b79587bb8 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PasswordComplexityRule.mdx @@ -0,0 +1,77 @@ +--- +title: "PasswordComplexityRule" +--- + +Defined in: [interfaces/models/transaction.ts:136](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/transaction.ts#L136) + + + +```ts Example +export interface PasswordComplexityRule { + code: string; + label: string; + status: 'valid' | 'error'; + isValid: boolean; + args?: { + count: number; + total?: number; + example?: string; + }; + items?: PasswordComplexityRule[]; +} +``` + + +## Properties + + +{/*> `optional` **args**: `object`*/} + +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**: `number`*/} + + +{/*> `optional` **example**: `string`*/} + + +{/*> `optional` **total**: `number`*/} + + + + + +{/*> **code**: `string`*/} + +Defined in: [interfaces/models/transaction.ts:137](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/transaction.ts#L137) + + + + +{/*> **isValid**: `boolean`*/} + +Defined in: [interfaces/models/transaction.ts:140](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/transaction.ts#L140) + + + + +{/*> `optional` **items**: `PasswordComplexityRule`[]*/} + +Defined in: [interfaces/models/transaction.ts:146](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/transaction.ts#L146) + + + + +{/*> **label**: `string`*/} + +Defined in: [interfaces/models/transaction.ts:138](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/transaction.ts#L138) + + + + +{/*> **status**: `"valid"` \| `"error"`*/} + +Defined in: [interfaces/models/transaction.ts:139](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/transaction.ts#L139) + \ 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..2a3175c8f --- /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/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/transaction.ts#L57) + + + +```ts Example +export interface PasswordPolicy { + enabled?: boolean; + minLength?: number; + policy: 'none' | 'low' | 'fair' | 'good' | 'excellent'; + passwordSecurityInfo?: PasswordComplexityRule[]; +} +``` + + +## Properties + + +{/*> `optional` **enabled**: `boolean`*/} + +Defined in: [interfaces/models/transaction.ts:58](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/transaction.ts#L58) + + + + +{/*> `optional` **minLength**: `number`*/} + +Defined in: [interfaces/models/transaction.ts:59](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/transaction.ts#L59) + + + +[PasswordComplexityRule][]}> +{/*> `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/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/transaction.ts#L61) + + + + +{/*> **policy**: `"none"` \| `"low"` \| `"fair"` \| `"good"` \| `"excellent"`*/} + +Defined in: [interfaces/models/transaction.ts:60](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/transaction.ts#L60) + \ 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..86240bb15 --- /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/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/utils/validate-password.ts#L2) + + + +```ts Example +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[]; +} +``` + + +## Properties + + +{/*> **isValid**: `boolean`*/} + +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. + +`true` only if every rule in [PasswordComplexityRule](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PasswordComplexityRule) has `status` equal to `"valid"`. + + + +PasswordComplexityRule}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#status) field reflects the +computed validation result for that rule. + \ 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..d934f228b --- /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/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/phone-identifier-challenge.ts#L6) + + + +```ts Example +export interface PhoneChallengeOptions { + code: string; + captcha?: string; + [key: string]: string | number | boolean | undefined; +} +``` + + +## Indexable + +\[`key`: `string`\]: `string` \| `number` \| `boolean` \| `undefined` + +## Properties + + +{/*> `optional` **captcha**: `string`*/} + +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) + + + + +{/*> **code**: `string`*/} + +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) + \ 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..d9c402725 --- /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/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/phone-identifier-enrollment.ts#L18) + + + +```ts Example +export interface PhoneEnrollmentOptions { + type: 'text' | 'voice'; + [key: string]: string | number | boolean; +} +``` + + +## Indexable + +\[`key`: `string`\]: `string` \| `number` \| `boolean` + +## Properties + + +{/*> **type**: `"voice"` \| `"text"`*/} + +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) + \ 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..97f5d17cc --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PhoneIdentifierChallengeMembers.mdx @@ -0,0 +1,195 @@ +--- +title: "PhoneIdentifierChallengeMembers" +--- + +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) + + + +```ts Example +export interface PhoneIdentifierChallengeMembers extends BaseMembers { + screen: ScreenMembersOnPhoneIdentifierChallenge; + submitPhoneChallenge(payload: PhoneChallengeOptions): Promise; + resendCode(payload?: CustomOptions): Promise; + resendManager(options?: StartResendOptions): ResendControl; + returnToPrevious(payload?: CustomOptions): Promise; + switchToVoice(payload?: CustomOptions): Promise; + switchToText(payload?: CustomOptions): Promise; +} +``` + + +- Extends [`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers) + +## Properties + +BrandingMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#branding) + + + +ClientMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#client) + + + +OrganizationMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#organization) + + + +PromptMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#prompt) + + + +ScreenMembersOnPhoneIdentifierChallenge}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#screen) + + + +TenantMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#tenant) + + + +TransactionMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#transaction) + + + +UntrustedDataMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#untrusteddata) + + + +UserMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#user) + + +## Methods + + +{/*> **resendCode**(`payload?`): `Promise`\<`void`\>*/} + +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) + + +CustomOptions}> +[`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CustomOptions) + + + +- Returns `Promise`\<`void`\> + + + +ResendControl}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/phone-identifier-challenge.ts#L40) + + +StartResendOptions}> +[`StartResendOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/StartResendOptions) + + + +- Returns [`ResendControl`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResendControl) + + + + +{/*> **returnToPrevious**(`payload?`): `Promise`\<`void`\>*/} + +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) + + +CustomOptions}> +[`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CustomOptions) + + + +- Returns `Promise`\<`void`\> + + + + +{/*> **submitPhoneChallenge**(`payload`): `Promise`\<`void`\>*/} + +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) + + +PhoneChallengeOptions}> +[`PhoneChallengeOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PhoneChallengeOptions) + + + +- Returns `Promise`\<`void`\> + + + + +{/*> **switchToText**(`payload?`): `Promise`\<`void`\>*/} + +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) + + +CustomOptions}> +[`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CustomOptions) + + + +- Returns `Promise`\<`void`\> + + + + +{/*> **switchToVoice**(`payload?`): `Promise`\<`void`\>*/} + +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) + + +CustomOptions}> +[`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CustomOptions) + + + +- Returns `Promise`\<`void`\> + \ 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..b4cc2e0f5 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PhoneIdentifierEnrollmentMembers.mdx @@ -0,0 +1,131 @@ +--- +title: "PhoneIdentifierEnrollmentMembers" +--- + +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) + + + +```ts Example +export interface PhoneIdentifierEnrollmentMembers extends BaseMembers { + screen: ScreenMembersOnPhoneIdentifierEnrollment; + continuePhoneEnrollment(payload: PhoneEnrollmentOptions): Promise; + returnToPrevious(payload?: CustomOptions): Promise; +} +``` + + +- Extends [`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers) + +## Properties + +BrandingMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#branding) + + + +ClientMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#client) + + + +OrganizationMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#organization) + + + +PromptMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#prompt) + + + +ScreenMembersOnPhoneIdentifierEnrollment}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#screen) + + + +TenantMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#tenant) + + + +TransactionMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#transaction) + + + +UntrustedDataMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#untrusteddata) + + + +UserMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#user) + + +## Methods + + +{/*> **continuePhoneEnrollment**(`payload`): `Promise`\<`void`\>*/} + +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) + + +PhoneEnrollmentOptions}> +[`PhoneEnrollmentOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PhoneEnrollmentOptions) + + + +- Returns `Promise`\<`void`\> + + + + +{/*> **returnToPrevious**(`payload?`): `Promise`\<`void`\>*/} + +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) + + +CustomOptions}> +[`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CustomOptions) + + + +- Returns `Promise`\<`void`\> + \ 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..13988a0bd --- /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/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/screen.ts#L49) + + + +```ts Example +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; +} +``` + + +## Properties + + +{/*> **country**: `string`*/} + +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 + + + +### country\_code + +> **country\_code**: `string` + +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') + + +### phone\_prefix + +> **phone\_prefix**: `string` + +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 new file mode 100644 index 000000000..7dac6aca2 --- /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/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/prompt.ts#L5) + + + +```ts Example +export interface PromptMembers { + name: string; +} +``` + + +## Properties + + +{/*> **name**: `string`*/} + +Defined in: [interfaces/models/prompt.ts:6](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/prompt.ts#L6) + \ 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..590da9e8c --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/RedeemTicketMembers.mdx @@ -0,0 +1,152 @@ +--- +title: "RedeemTicketMembers" +--- + +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. + + + +```ts Example +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} 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; +} +``` + + +- Extends [`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers) + +## Properties + +BrandingMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#branding) + + + +ClientMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#client) + + + +OrganizationMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#organization) + + + +PromptMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#prompt) + + + +ScreenMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#screen) + + + +TenantMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#tenant) + + + +TransactionMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#transaction) + + + +UntrustedDataMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#untrusteddata) + + + +UserMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#user) + + +## Methods + + +{/*> **continue**(`payload?`): `Promise`\<`void`\>*/} + +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. + + +CustomOptions}> +[`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/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. + +```typescript Example +import RedeemTicket from '@auth0/auth0-acul-js/redeem-ticket'; + +const redeemTicket = new RedeemTicket(); +await redeemTicket.continue(); +``` + \ 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..b854686d6 --- /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/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/mfa-webauthn-platform-enrollment.ts#L37) + +ReportBrowserErrorOptions + + + +```ts Example +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; + }; +} +``` + + +## Properties + + +{/*> **error**: `object`*/} + +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 + +{/*> **message**: `string`*/} + +#### name + +{/*> **name**: `string`*/} + \ 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..8d67a0d45 --- /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/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/reset-password-mfa-email-challenge.ts#L29) + +Options for resending the email code. + + + +```ts Example +export interface ResendCodeOptions { + /** Any additional custom options */ + [key: string]: string | number | boolean | undefined; +} +``` + + +## 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..d9e6655fb --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResendCodeOptionsPayload.mdx @@ -0,0 +1,23 @@ +--- +title: "ResendCodeOptionsPayload" +--- + +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. +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. + + + +```ts Example +export interface ResendCodeOptions extends CustomOptions {} +``` + + +- 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..52884bf0a --- /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/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/mfa-email-challenge.ts#L41) + +Options for resending the email code + + + +```ts Example +export interface ResendCodeOptions { + /** Any additional custom options */ + [key: string]: string | number | boolean | undefined; +} +``` + + +## 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..aa62b4739 --- /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/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/utils/resend-control.ts#L20) + +Control object returned by resendManager method + + + +```ts Example +export interface ResendControl { + startResend: () => void; +} +``` + + +## Properties + +{/*> **startResend**: () => `void`*/} + +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` + + \ 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..2f6709a52 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordEmailMembers.mdx @@ -0,0 +1,115 @@ +--- +title: "ResetPasswordEmailMembers" +--- + +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) + + + +```ts Example +export interface ResetPasswordEmailMembers extends BaseMembers { + screen: ScreenMembersOnResetPasswordEmail; + resendEmail(payload?: CustomOptions): Promise; +} +``` + + +- Extends [`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers) + +## Properties + +BrandingMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#branding) + + + +ClientMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#client) + + + +OrganizationMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#organization) + + + +PromptMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#prompt) + + + +ScreenMembersOnResetPasswordEmail}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#screen) + + + +TenantMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#tenant) + + + +TransactionMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#transaction) + + + +UntrustedDataMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#untrusteddata) + + + +UserMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#user) + + +## Methods + + +{/*> **resendEmail**(`payload?`): `Promise`\<`void`\>*/} + +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) + + +CustomOptions}> +[`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CustomOptions) + + + +- Returns `Promise`\<`void`\> + \ 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..8698dd5e3 --- /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/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/reset-password-email.ts#L5) + + + +```ts Example +export interface ResetPasswordEmailOptions { + [key: string]: string | number | boolean | undefined; +} +``` + + +## 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..fec704170 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordErrorMembers.mdx @@ -0,0 +1,98 @@ +--- +title: "ResetPasswordErrorMembers" +--- + +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) + + + +```ts Example +export interface ResetPasswordErrorMembers extends BaseMembers { + screen: ScreenMembersOnResetPasswordError; +} +``` + + +- Extends [`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers) + +## Properties + +BrandingMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#branding) + + + +ClientMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#client) + + + +OrganizationMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#organization) + + + +PromptMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#prompt) + + + +ScreenMembersOnResetPasswordError}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#screen) + + + +TenantMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#tenant) + + + +TransactionMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#transaction) + + + +UntrustedDataMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#untrusteddata) + + + +UserMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#user) + \ 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..fbeea71df --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMembers.mdx @@ -0,0 +1,132 @@ +--- +title: "ResetPasswordMembers" +--- + +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) + + + +```ts Example +export interface ResetPasswordMembers extends BaseMembers { + screen: ScreenMembersOnResetPassword; + transaction: TransactionMembersOnResetPassword; + resetPassword(payload: ResetPasswordOptions): Promise; + validatePassword(password: string): PasswordValidationResult; +} +``` + + +- Extends [`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers) + +## Properties + +BrandingMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#branding) + + + +ClientMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#client) + + + +OrganizationMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#organization) + + + +PromptMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#prompt) + + + +ScreenMembersOnResetPassword}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#screen) + + + +TenantMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#tenant) + + + +TransactionMembersOnResetPassword}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#transaction) + + + +UntrustedDataMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#untrusteddata) + + + +UserMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#user) + + +## Methods + + +{/*> **resetPassword**(`payload`): `Promise`\<`void`\>*/} + +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) + + +ResetPasswordOptions}> +[`ResetPasswordOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordOptions) + + + +- Returns `Promise`\<`void`\> + + + +PasswordValidationResult}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/reset-password.ts#L26) + + + +`string` + + + +- Returns [`PasswordValidationResult`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PasswordValidationResult) + \ 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..c3565ec34 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMfaEmailChallengeMembers.mdx @@ -0,0 +1,201 @@ +--- +title: "ResetPasswordMfaEmailChallengeMembers" +--- + +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 + + + +```ts Example +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; + + /** + * Resends the email code. + * @param payload Optional custom options to include with the request. + */ + resendCode(payload?: ResendCodeOptions): Promise; + + /** + * Allows the user to try another MFA method. + * @param payload Optional custom options to include with the request. + */ + tryAnotherMethod(payload?: TryAnotherMethodOptions): Promise; + + /** + * Gets resend functionality with timeout management for this screen + * @param options Configuration options for resend functionality + */ + resendManager(options?: StartResendOptions): ResendControl; +} +``` + + +- Extends [`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers) + +## Properties + +BrandingMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#branding) + + + +ClientMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#client) + + + +OrganizationMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#organization) + + + +PromptMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#prompt) + + + +ScreenMembersOnResetPasswordMfaEmailChallenge}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#screen) + + + +TenantMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#tenant) + + + +TransactionMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#transaction) + + + +UntrustedDataMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#untrusteddata) + + + +UserMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#user) + + +## Methods + + +{/*> **continue**(`payload`): `Promise`\<`void`\>*/} + +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. + + +ContinueOptions}> +[`ContinueOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ContinueOptions) + +The options containing the code and rememberDevice flag. + + + +- Returns `Promise`\<`void`\> + + + + +{/*> **resendCode**(`payload?`): `Promise`\<`void`\>*/} + +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. + + +ResendCodeOptions}> +[`ResendCodeOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResendCodeOptions) + +Optional custom options to include with the request. + + + +- Returns `Promise`\<`void`\> + + + +ResendControl}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/reset-password-mfa-email-challenge.ts#L70) + +Gets resend functionality with timeout management for this screen + + +StartResendOptions}> +[`StartResendOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/StartResendOptions) + +Configuration options for resend functionality + + + +- Returns [`ResendControl`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResendControl) + + + + +{/*> **tryAnotherMethod**(`payload?`): `Promise`\<`void`\>*/} + +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. + + +TryAnotherMethodOptions}> +[`TryAnotherMethodOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TryAnotherMethodOptions) + +Optional custom options to include with the request. + + + +- Returns `Promise`\<`void`\> + \ 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..c3a4ef72c --- /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/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/reset-password-mfa-otp-challenge.ts#L6) + +Options for continuing with the OTP challenge. + + + +```ts Example +export interface ContinueOptions { + /** The code entered by the user. */ + code: string; + /** Any additional custom options */ + [key: string]: string | number | boolean | undefined; +} +``` + + +## Indexable + +\[`key`: `string`\]: `string` \| `number` \| `boolean` \| `undefined` + +Any additional custom options + +## Properties + + +{/*> **code**: `string`*/} + +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. + \ 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..5b433e0da --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMfaOtpChallengeMembers.mdx @@ -0,0 +1,148 @@ +--- +title: "ResetPasswordMfaOtpChallengeMembers" +--- + +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 + + + +```ts Example +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; + /** + * Allows the user to try another MFA method. + * @param payload Optional custom options to include with the request. + */ + tryAnotherMethod(payload?: TryAnotherMethodOptions): Promise; +} +``` + + +- Extends [`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers) + +## Properties + +BrandingMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#branding) + + + +ClientMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#client) + + + +OrganizationMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#organization) + + + +PromptMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#prompt) + + + +ScreenMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#screen) + + + +TenantMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#tenant) + + + +TransactionMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#transaction) + + + +UntrustedDataMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#untrusteddata) + + + +UserMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#user) + + +## Methods + + +{/*> **continue**(`payload`): `Promise`\<`void`\>*/} + +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. + + +ResetPasswordMfaOtpChallengeContinueOptions}> +[`ResetPasswordMfaOtpChallengeContinueOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMfaOtpChallengeContinueOptions) + +The options containing the code. + + + +- Returns `Promise`\<`void`\> + + + + +{/*> **tryAnotherMethod**(`payload?`): `Promise`\<`void`\>*/} + +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. + + +ResetPasswordMfaOtpChallengeTryAnotherMethodOptions}> +[`ResetPasswordMfaOtpChallengeTryAnotherMethodOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMfaOtpChallengeTryAnotherMethodOptions) + +Optional custom options to include with the request. + + + +- Returns `Promise`\<`void`\> + \ 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..b7935e20e --- /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/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/reset-password-mfa-otp-challenge.ts#L16) + +Options for trying another method. + + + +```ts Example +export interface TryAnotherMethodOptions { + /** Any additional custom options */ + [key: string]: string | number | boolean | undefined; +} +``` + + +## 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..df6360d83 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMfaPhoneChallengeContinueOptions.mdx @@ -0,0 +1,40 @@ +--- +title: "ResetPasswordMfaPhoneChallengeContinueOptions" +--- + +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 + + + +```ts Example +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'; +} +``` + + +- Extends [`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CustomOptions) + +## Indexable + +\[`key`: `string`\]: `string` \| `number` \| `boolean` \| `undefined` + +## Properties + + +{/*> **type**: `"sms"` \| `"voice"`*/} + +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. +- `voice`: Send the code via a voice call. + \ 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..b42938e8d --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMfaPhoneChallengeMembers.mdx @@ -0,0 +1,261 @@ +--- +title: "ResetPasswordMfaPhoneChallengeMembers" +--- + +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 + + + +```ts Example +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} 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; + + /** + * 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} 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; +} +``` + + +- Extends [`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers) + +## Properties + +BrandingMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#branding) + + + +ClientMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#client) + + + +OrganizationMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#organization) + + + +PromptMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#prompt) + + + +ScreenMembersOnResetPasswordMfaPhoneChallenge}> +{/*> **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/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. + +- 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#screen) + + + +TenantMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#tenant) + + + +TransactionMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#transaction) + + + +UntrustedDataMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#untrusteddata) + + + +UserMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#user) + + +## Methods + + +{/*> **continue**(`payload`): `Promise`\<`void`\>*/} + +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. +It triggers the Auth0 backend to initiate the code delivery process. + + +ResetPasswordMfaPhoneChallengeContinueOptions}> +[`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. + + + +- 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). + +```typescript Example +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' }); +``` + + + + +{/*> **tryAnotherMethod**(`payload`): `Promise`\<`void`\>*/} + +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. + + +ResetPasswordMfaPhoneChallengeTryAnotherMethodOptions}> +[`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. + + + +- Returns `Promise`\<`void`\> + +A promise that resolves when the action is successfully submitted to the server. + +#### Throws + +Throws an error if the submission fails. + +```typescript Example +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' }); +``` + \ 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..8f798c05c --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMfaPhoneChallengeTryAnotherMethodOptions.mdx @@ -0,0 +1,42 @@ +--- +title: "ResetPasswordMfaPhoneChallengeTryAnotherMethodOptions" +--- + +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 + + + +```ts Example +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'; +} +``` + + +- Extends [`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CustomOptions) + +## Indexable + +\[`key`: `string`\]: `string` \| `number` \| `boolean` \| `undefined` + +## Properties + + +{/*> **type**: `"sms"` \| `"voice"`*/} + +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. +- `sms`: Indicates the current screen was for SMS challenge. +- `voice`: Indicates the current screen was for Voice challenge. + \ 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..9af75d328 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMfaPushChallengePushMembers.mdx @@ -0,0 +1,226 @@ +--- +title: "ResetPasswordMfaPushChallengePushMembers" +--- + +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 + + + +```ts Example +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; + + /** + * Resends the push notification + * @param payload Optional custom options to include with the request + */ + resendPushNotification(payload?: CustomOptions): Promise; + + /** + * Switches to entering the verification code manually + * @param payload Optional custom options to include with the request + */ + enterCodeManually(payload?: CustomOptions): Promise; + + /** + * Allows trying another authentication method + * @param payload Optional custom options to include with the request + */ + tryAnotherMethod(payload?: CustomOptions): Promise; + + /** + * Allows polling for the push notification challenge to be approved. + * @param options of type {@link MfaPollingOptions} + */ + pollingManager(options?: MfaPollingOptions): MfaPushPollingControl; +} +``` + + +- Extends [`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers) + +## Properties + +BrandingMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#branding) + + + +ClientMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#client) + + + +OrganizationMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#organization) + + + +PromptMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#prompt) + + + +ScreenMembersOnResetPasswordMfaPushChallengePush}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#screen) + + + +TenantMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#tenant) + + + +TransactionMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#transaction) + + + +UntrustedDataMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#untrusteddata) + + + +UserMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#user) + + +## Methods + + +{/*> **continue**(`payload?`): `Promise`\<`void`\>*/} + +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 + + +CustomOptions}> +[`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CustomOptions) + +Optional custom options to include with the request + + + +- Returns `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/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/reset-password-mfa-push-challenge-push.ts#L42) + +Switches to entering the verification code manually + + +CustomOptions}> +[`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CustomOptions) + +Optional custom options to include with the request + + + +- Returns `Promise`\<`void`\> + + + +MfaPushPollingControl}> +{/*> **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/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. + + +MfaPollingOptions}> +[`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) + + + +- Returns [`MfaPushPollingControl`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaPushPollingControl) + + + + +{/*> **resendPushNotification**(`payload?`): `Promise`\<`void`\>*/} + +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 + + +CustomOptions}> +[`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CustomOptions) + +Optional custom options to include with the request + + + +- Returns `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/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/reset-password-mfa-push-challenge-push.ts#L48) + +Allows trying another authentication method + + +CustomOptions}> +[`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CustomOptions) + +Optional custom options to include with the request + + + +- Returns `Promise`\<`void`\> + \ 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..cb22dba26 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMfaRecoveryCodeChallengeMembers.mdx @@ -0,0 +1,163 @@ +--- +title: "ResetPasswordMfaRecoveryCodeChallengeMembers" +--- + +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. + + + +```ts Example +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} + */ + continue(code: string, payload?: CustomOptions): Promise; + + /** + * Navigates to the screen where the user can pick another MFA method. + * @param {CustomOptions} [payload] - Optional payload. + * @returns {Promise} + */ + tryAnotherMethod(payload?: CustomOptions): Promise; +} +``` + + +- Extends [`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers) + +## Properties + +BrandingMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#branding) + + + +ClientMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#client) + + + +OrganizationMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#organization) + + + +PromptMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#prompt) + + + +ScreenMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#screen) + + + +TenantMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#tenant) + + + +TransactionMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#transaction) + + + +UntrustedDataMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#untrusteddata) + + + +UserMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#user) + + +## Methods + + +{/*> **continue**(`code`, `payload?`): `Promise`\<`void`\>*/} + +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. + + + +`string` + +The recovery code entered by the user. + +CustomOptions}> +[`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CustomOptions) + +Optional payload. + + + +- Returns `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/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. + + +CustomOptions}> +[`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CustomOptions) + +Optional payload. + + + +- Returns `Promise`\<`void`\> + \ 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..cc53b30c7 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMfaSmsChallengeMembers.mdx @@ -0,0 +1,187 @@ +--- +title: "ResetPasswordMfaSmsChallengeMembers" +--- + +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) + + + +```ts Example +export interface ResetPasswordMfaSmsChallengeMembers extends BaseMembers { + screen: ScreenMembersOnResetPasswordMfaSmsChallenge; + continueMfaSmsChallenge(payload: MfaSmsChallengeOptions): Promise; + resendCode(payload?: CustomOptions): Promise; + tryAnotherMethod(payload?: CustomOptions): Promise; + getACall(payload?: CustomOptions): Promise; + /** + * Gets resend functionality with timeout management for this screen + * @param options Configuration options for resend functionality + */ + resendManager(options?: StartResendOptions): ResendControl; +} +``` + + +- Extends [`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers) + +## Properties + +BrandingMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#branding) + + + +ClientMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#client) + + + +OrganizationMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#organization) + + + +PromptMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#prompt) + + + +ScreenMembersOnResetPasswordMfaSmsChallenge}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#screen) + + + +TenantMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#tenant) + + + +TransactionMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#transaction) + + + +UntrustedDataMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#untrusteddata) + + + +UserMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#user) + + +## Methods + + +{/*> **continueMfaSmsChallenge**(`payload`): `Promise`\<`void`\>*/} + +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) + + +ResetPasswordMfaSmsChallengeOptions}> +[`ResetPasswordMfaSmsChallengeOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMfaSmsChallengeOptions) + + + +- Returns `Promise`\<`void`\> + + + + +{/*> **getACall**(`payload?`): `Promise`\<`void`\>*/} + +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) + + +CustomOptions}> +[`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CustomOptions) + + + +- Returns `Promise`\<`void`\> + + + + +{/*> **resendCode**(`payload?`): `Promise`\<`void`\>*/} + +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) + + +CustomOptions}> +[`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CustomOptions) + + + +- Returns `Promise`\<`void`\> + + + +ResendControl}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/reset-password-mfa-sms-challenge.ts#L31) + +Gets resend functionality with timeout management for this screen + + +StartResendOptions}> +[`StartResendOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/StartResendOptions) + +Configuration options for resend functionality + + + +- Returns [`ResendControl`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResendControl) + + + + +{/*> **tryAnotherMethod**(`payload?`): `Promise`\<`void`\>*/} + +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) + + +CustomOptions}> +[`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CustomOptions) + + + +- Returns `Promise`\<`void`\> + \ 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..77c09edf3 --- /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/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/reset-password-mfa-sms-challenge.ts#L6) + + + +```ts Example +export interface MfaSmsChallengeOptions { + code: string; + [key: string]: string | number | boolean | undefined; +} +``` + + +## Indexable + +\[`key`: `string`\]: `string` \| `number` \| `boolean` \| `undefined` + +## Properties + + +{/*> **code**: `string`*/} + +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) + \ 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..02713dbeb --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMfaVoiceChallengeContinueOptions.mdx @@ -0,0 +1,35 @@ +--- +title: "ResetPasswordMfaVoiceChallengeContinueOptions" +--- + +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. + + + +```ts Example +export interface ContinueOptions extends CustomOptions { + /** + * The OTP code entered by the user. + */ + code: string; +} +``` + + +- Extends [`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CustomOptions) + +## Indexable + +\[`key`: `string`\]: `string` \| `number` \| `boolean` \| `undefined` + +## Properties + + +{/*> **code**: `string`*/} + +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. + \ 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..bfe17d2f4 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMfaVoiceChallengeMembers.mdx @@ -0,0 +1,253 @@ +--- +title: "ResetPasswordMfaVoiceChallengeMembers" +--- + +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. + + + +```ts Example +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; + + /** + * 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; + + /** + * 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; + + /** + * 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; + + /** + * Gets resend functionality with timeout management for this screen + * @param options Configuration options for resend functionality + */ + resendManager(options?: StartResendOptions): ResendControl; +} +``` + + +- Extends [`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers) + +## Properties + +BrandingMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#branding) + + + +ClientMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#client) + + + +OrganizationMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#organization) + + + +PromptMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#prompt) + + + +ScreenMembersOnResetPasswordMfaVoiceChallenge}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#screen) + + + +TenantMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#tenant) + + + +TransactionMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#transaction) + + + +UntrustedDataMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#untrusteddata) + + + +UserMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#user) + + +## Methods + + +{/*> **continue**(`payload`): `Promise`\<`void`\>*/} + +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. + + +ResetPasswordMfaVoiceChallengeContinueOptions}> +[`ResetPasswordMfaVoiceChallengeContinueOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMfaVoiceChallengeContinueOptions) + +The options containing the code. + + + +- Returns `Promise`\<`void`\> + +A promise that resolves when the challenge is submitted. + +```ts Example +const reset = new ResetPasswordMfaVoiceChallenge(); +await reset.continue({ code: '123456' }); +``` + + + + +{/*> **resendCode**(`payload?`): `Promise`\<`void`\>*/} + +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. + + +CustomOptions}> +[`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CustomOptions) + +Optional custom options to include with the request. + + + +- Returns `Promise`\<`void`\> + +A promise that resolves when the code is resent. + + + +ResendControl}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/reset-password-mfa-voice-challenge.ts#L81) + +Gets resend functionality with timeout management for this screen + + +StartResendOptions}> +[`StartResendOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/StartResendOptions) + +Configuration options for resend functionality + + + +- Returns [`ResendControl`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResendControl) + + + + +{/*> **switchToSms**(`payload?`): `Promise`\<`void`\>*/} + +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. + + +CustomOptions}> +[`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CustomOptions) + +Optional custom options to include with the request. + + + +- Returns `Promise`\<`void`\> + +A promise that resolves when the action completes. + + + + +{/*> **tryAnotherMethod**(`payload?`): `Promise`\<`void`\>*/} + +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. + + +CustomOptions}> +[`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CustomOptions) + +Optional custom options to include with the request. + + + +- Returns `Promise`\<`void`\> + +A promise that resolves when the request is submitted. + \ 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..5b6cf5a88 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMfaWebAuthnPlatformChallengeContinueOptions.mdx @@ -0,0 +1,39 @@ +--- +title: "ResetPasswordMfaWebAuthnPlatformChallengeContinueOptions" +--- + +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 + + + +```ts Example +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; +} +``` + + +- Extends [`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CustomOptions) + +## Indexable + +\[`key`: `string`\]: `string` \| `number` \| `boolean` \| `undefined` + +## Properties + + +{/*> `optional` **rememberDevice**: `boolean`*/} + +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, + potentially skipping MFA for a period. Corresponds to the `rememberBrowser` form field. + \ 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..0834b91a8 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMfaWebAuthnPlatformChallengeMembers.mdx @@ -0,0 +1,316 @@ +--- +title: "ResetPasswordMfaWebAuthnPlatformChallengeMembers" +--- + +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 + + + +```ts Example +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} 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; + + /** + * 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} 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; + + /** + * 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} 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; +} +``` + + +- Extends [`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers) + +## Properties + +BrandingMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#branding) + + + +ClientMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#client) + + + +OrganizationMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#organization) + + + +PromptMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#prompt) + + + +ScreenMembersOnResetPasswordMfaWebAuthnPlatformChallenge}> +{/*> **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/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. + +- 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#screen) + + + +TenantMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#tenant) + + + +TransactionMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#transaction) + + + +UntrustedDataMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#untrusteddata) + + + +UserMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#user) + + +## Methods + + +{/*> **continueWithPasskey**(`options?`): `Promise`\<`void`\>*/} + +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`. +If successful, it submits the resulting credential assertion to Auth0 with `action: "default"`. + + +ResetPasswordMfaWebAuthnPlatformChallengeContinueOptions}> +[`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. + + + +- 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`. + +```typescript Example +// 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. +} +``` + + + + +{/*> **reportBrowserError**(`options`): `Promise`\<`void`\>*/} + +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. +It submits the error details with `action: "showError::{errorDetailsJsonString}"`. + + +ResetPasswordMfaWebAuthnPlatformChallengeReportErrorOptions}> +[`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. + + + +- Returns `Promise`\<`void`\> + +A promise that resolves when the error report is submitted. + +#### Throws + +If the form submission fails (e.g., network error). + +```typescript Example +// 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); +} +``` + + + + +{/*> **tryAnotherMethod**(`options?`): `Promise`\<`void`\>*/} + +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 +the user to an MFA factor selection screen for the password reset flow. + + +ResetPasswordMfaWebAuthnPlatformChallengeTryAnotherMethodOptions}> +[`ResetPasswordMfaWebAuthnPlatformChallengeTryAnotherMethodOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/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. + +```typescript Example +// 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); +} +``` + \ 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..6a9229e51 --- /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/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/reset-password-mfa-webauthn-platform-challenge.ts#L77) + +ReportBrowserErrorOptions + + + +```ts Example +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; +} +``` + + +## Properties + +WebAuthnErrorDetails}> +{/*> **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/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`. + \ 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..4300df1b6 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMfaWebAuthnPlatformChallengeTryAnotherMethodOptions.mdx @@ -0,0 +1,23 @@ +--- +title: "ResetPasswordMfaWebAuthnPlatformChallengeTryAnotherMethodOptions" +--- + +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 + + + +```ts Example +export interface TryAnotherMethodOptions extends CustomOptions { + // Currently, no specific properties beyond CustomOptions are defined for this action. + // This interface is here for future extensibility. +} +``` + + +- 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..db4909133 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMfaWebAuthnRoamingChallengeMembers.mdx @@ -0,0 +1,248 @@ +--- +title: "ResetPasswordMfaWebAuthnRoamingChallengeMembers" +--- + +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 + + + +```ts Example +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} 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; + + /** + * 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} 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; + + /** + * 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} 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; +} +``` + + +- Extends [`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers) + +## Properties + +BrandingMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#branding) + + + +ClientMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#client) + + + +OrganizationMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#organization) + + + +PromptMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#prompt) + + + +ScreenMembersOnResetPasswordMfaWebAuthnRoamingChallenge}> +{/*> **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/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. + +- 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#screen) + + + +TenantMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#tenant) + + + +TransactionMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#transaction) + + + +UntrustedDataMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#untrusteddata) + + + +UserMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#user) + + +## Methods + + +{/*> **showError**(`options`): `Promise`\<`void`\>*/} + +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) +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`. + + +ResetPasswordMfaWebAuthnRoamingChallengeShowErrorOptions}> +[`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. + + + +- 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). + + + + +{/*> **tryAnotherMethod**(`options?`): `Promise`\<`void`\>*/} + +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 +the user to an MFA factor selection screen. + + +ResetPasswordMfaWebAuthnRoamingChallengeTryAnotherMethodOptions}> +[`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. + + + +- Returns `Promise`\<`void`\> + +A promise that resolves when the 'pick-authenticator' action is submitted. + +#### Throws + +Throws an error if the form submission fails. + + + + +{/*> **useSecurityKey**(`options?`): `Promise`\<`void`\>*/} + +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 +provided in `screen.publicKey`. +On successful interaction with the security key, it submits the resulting +`PublicKeyCredential` to Auth0 with `action: "default"`. + + +ResetPasswordMfaWebAuthnRoamingChallengeUseSecurityKeyOptions}> +[`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. + + + +- 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. + \ 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..883d4c06c --- /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/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/reset-password-mfa-webauthn-roaming-challenge.ts#L96) + +ShowErrorOptions + + + +```ts Example +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; +} +``` + + +## Properties + +WebAuthnErrorDetails}> +{/*> **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/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. + + + + +{/*> `optional` **rememberDevice**: `boolean`*/} + +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. + \ 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..114388773 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMfaWebAuthnRoamingChallengeTryAnotherMethodOptions.mdx @@ -0,0 +1,39 @@ +--- +title: "ResetPasswordMfaWebAuthnRoamingChallengeTryAnotherMethodOptions" +--- + +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 + + + +```ts Example +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; +} +``` + + +- Extends [`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CustomOptions) + +## Indexable + +\[`key`: `string`\]: `string` \| `number` \| `boolean` \| `undefined` + +## Properties + + +{/*> `optional` **rememberDevice**: `boolean`*/} + +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. + \ 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..db5cd965d --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMfaWebAuthnRoamingChallengeUseSecurityKeyOptions.mdx @@ -0,0 +1,41 @@ +--- +title: "ResetPasswordMfaWebAuthnRoamingChallengeUseSecurityKeyOptions" +--- + +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 + + + +```ts Example +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; +} +``` + + +- Extends [`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CustomOptions) + +## Indexable + +\[`key`: `string`\]: `string` \| `number` \| `boolean` \| `undefined` + +## Properties + + +{/*> `optional` **rememberDevice**: `boolean`*/} + +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 +choice to remember this device. + \ 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..c21fbbeb4 --- /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/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/reset-password.ts#L6) + + + +```ts Example +export interface ResetPasswordOptions { + 'password-reset': string; + 're-enter-password': string; + [key: string]: string | number | boolean | undefined; +} +``` + + +## 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/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/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 new file mode 100644 index 000000000..46f17a0ae --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordRequestMembers.mdx @@ -0,0 +1,142 @@ +--- +title: "ResetPasswordRequestMembers" +--- + +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) + + + +```ts Example +export interface ResetPasswordRequestMembers extends BaseMembers { + screen: ScreenMembersOnResetPasswordRequest; + transaction: TransactionMembersOnResetPasswordRequest; + resetPassword(payload: ResetPasswordRequestOptions): Promise; + backToLogin(payload?: CustomOptions): Promise; + getLoginIdentifiers(): IdentifierType[] | null; +} +``` + + +- Extends [`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers) + +## Properties + +BrandingMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#branding) + + + +ClientMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#client) + + + +OrganizationMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#organization) + + + +PromptMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#prompt) + + + +ScreenMembersOnResetPasswordRequest}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#screen) + + + +TenantMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#tenant) + + + +TransactionMembersOnResetPasswordRequest}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#transaction) + + + +UntrustedDataMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#untrusteddata) + + + +UserMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#user) + + +## Methods + + +{/*> **backToLogin**(`payload?`): `Promise`\<`void`\>*/} + +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) + + +CustomOptions}> +[`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CustomOptions) + + + +- Returns `Promise`\<`void`\> + + + +IdentifierType[]}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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` + + + + +{/*> **resetPassword**(`payload`): `Promise`\<`void`\>*/} + +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) + + +ResetPasswordRequestOptions}> +[`ResetPasswordRequestOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordRequestOptions) + + + +- Returns `Promise`\<`void`\> + \ 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..cb42d9766 --- /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/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/reset-password-request.ts#L7) + + + +```ts Example +export interface ResetPasswordRequestOptions { + username: string; + captcha?: string; + [key: string]: string | number | boolean | undefined; +} +``` + + +## Indexable + +\[`key`: `string`\]: `string` \| `number` \| `boolean` \| `undefined` + +## Properties + + +{/*> `optional` **captcha**: `string`*/} + +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) + + + + +{/*> **username**: `string`*/} + +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) + \ 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..f7e423d38 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordSuccessMembers.mdx @@ -0,0 +1,98 @@ +--- +title: "ResetPasswordSuccessMembers" +--- + +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) + + + +```ts Example +export interface ResetPasswordSuccessMembers extends BaseMembers { + screen: ScreenMembersOnResetPasswordSuccess; +} +``` + + +- Extends [`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers) + +## Properties + +BrandingMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#branding) + + + +ClientMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#client) + + + +OrganizationMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#organization) + + + +PromptMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#prompt) + + + +ScreenMembersOnResetPasswordSuccess}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#screen) + + + +TenantMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#tenant) + + + +TransactionMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#transaction) + + + +UntrustedDataMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#untrusteddata) + + + +UserMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#user) + \ 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..d0f23fb44 --- /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/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/screen.ts#L58) + + + +```ts Example +export interface Scope { + value: string; + description?: string; +} +``` + + +## Properties + + +{/*> `optional` **description**: `string`*/} + +Defined in: [interfaces/models/screen.ts:60](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/screen.ts#L60) + + + + +{/*> **value**: `string`*/} + +Defined in: [interfaces/models/screen.ts:59](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/screen.ts#L59) + \ 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..c17a428d9 --- /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/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/screen.ts#L80) + + + +```ts Example +export interface ScreenMembers { + name: string; + captchaImage: string | null; + captchaSiteKey: string | null; + captchaProvider: string | null; + isCaptchaAvailable: boolean; + data: Record | Array | PasskeyCreate> | null; + links: Record | null; + texts: Record | null; + captcha: CaptchaContext | null; +} +``` + + +## 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 + +CaptchaContext}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/screen.ts#L89) + + + + +{/*> **captchaImage**: `string` \| `null`*/} + +Defined in: [interfaces/models/screen.ts:82](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/screen.ts#L82) + + + + +{/*> **captchaProvider**: `string` \| `null`*/} + +Defined in: [interfaces/models/screen.ts:84](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/screen.ts#L84) + + + + +{/*> **captchaSiteKey**: `string` \| `null`*/} + +Defined in: [interfaces/models/screen.ts:83](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/screen.ts#L83) + + + +PasskeyCreate}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/screen.ts#L86) + + + + +{/*> **isCaptchaAvailable**: `boolean`*/} + +Defined in: [interfaces/models/screen.ts:85](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/screen.ts#L85) + + + + +{/*> **links**: `Record`\<`string`, `string`\> \| `null`*/} + +Defined in: [interfaces/models/screen.ts:87](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/screen.ts#L87) + + + + +{/*> **name**: `string`*/} + +Defined in: [interfaces/models/screen.ts:81](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/screen.ts#L81) + + + + +{/*> **texts**: `Record`\<`string`, `string`\> \| `null`*/} + +Defined in: [interfaces/models/screen.ts:88](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/screen.ts#L88) + \ 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..47a4805e0 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnAcceptInvitation.mdx @@ -0,0 +1,101 @@ +--- +title: "ScreenMembersOnAcceptInvitation" +--- + +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) + + + +```ts Example +export interface ScreenMembersOnAcceptInvitation extends ScreenMembers { + data: { + inviter: string; + email: string; + } | null; +} +``` + + +- Extends [`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers) + +## Properties + +CaptchaContext}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#captcha) + + + + +{/*> **captchaImage**: `string` \| `null`*/} + +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 [`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#captchaimage) + + + + +{/*> **captchaProvider**: `string` \| `null`*/} + +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 [`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#captchaprovider) + + + + +{/*> **captchaSiteKey**: `string` \| `null`*/} + +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 [`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#captchasitekey) + + + + +{/*> **data**: \{ `email`: `string`; `inviter`: `string`; \} \| `null`*/} + +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 [`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#data) + + + + +{/*> **isCaptchaAvailable**: `boolean`*/} + +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 [`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#iscaptchaavailable) + + + + +{/*> **links**: `Record`\<`string`, `string`\> \| `null`*/} + +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 [`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#links) + + + + +{/*> **name**: `string`*/} + +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 [`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#name) + + + + +{/*> **texts**: `Record`\<`string`, `string`\> \| `null`*/} + +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 [`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#texts) + \ 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..649c74e88 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnConsent.mdx @@ -0,0 +1,117 @@ +--- +title: "ScreenMembersOnConsent" +--- + +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 + + + +```ts Example +export interface ScreenMembersOnConsent extends ScreenMembers { + scopes: Scope[]; + hideScopes: boolean; +} +``` + + +- Extends [`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers) + +## Properties + +CaptchaContext}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#captcha) + + + + +{/*> **captchaImage**: `string` \| `null`*/} + +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 [`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#captchaimage) + + + + +{/*> **captchaProvider**: `string` \| `null`*/} + +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 [`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#captchaprovider) + + + + +{/*> **captchaSiteKey**: `string` \| `null`*/} + +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 [`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#captchasitekey) + + + +PasskeyCreate}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#data) + + + + +{/*> **hideScopes**: `boolean`*/} + +Defined in: [interfaces/screens/consent.ts:22](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/consent.ts#L22) + + + + +{/*> **isCaptchaAvailable**: `boolean`*/} + +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 [`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#iscaptchaavailable) + + + + +{/*> **links**: `Record`\<`string`, `string`\> \| `null`*/} + +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 [`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#links) + + + + +{/*> **name**: `string`*/} + +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 [`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#name) + + + +Scope}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/consent.ts#L21) + + + + +{/*> **texts**: `Record`\<`string`, `string`\> \| `null`*/} + +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 [`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#texts) + \ 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..bfd071024 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnCustomizedConsent.mdx @@ -0,0 +1,140 @@ +--- +title: "ScreenMembersOnCustomizedConsent" +--- + +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 + + + +```ts Example +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[]; +} +``` + + +- Extends [`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers) + +## Properties + +AuthorizationDetail}> +{/*> **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/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 +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. + + + +CaptchaContext}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#captcha) + + + + +{/*> **captchaImage**: `string` \| `null`*/} + +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 [`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#captchaimage) + + + + +{/*> **captchaProvider**: `string` \| `null`*/} + +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 [`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#captchaprovider) + + + + +{/*> **captchaSiteKey**: `string` \| `null`*/} + +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 [`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#captchasitekey) + + + +PasskeyCreate}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#data) + + + + +{/*> **isCaptchaAvailable**: `boolean`*/} + +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 [`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#iscaptchaavailable) + + + + +{/*> **links**: `Record`\<`string`, `string`\> \| `null`*/} + +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 [`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#links) + + + + +{/*> **name**: `string`*/} + +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 [`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#name) + + + +Scope}> +{/*> **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/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'. +This list should be displayed to the user for their review. + + + + +{/*> **texts**: `Record`\<`string`, `string`\> \| `null`*/} + +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 [`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#texts) + \ 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..d1f6c8660 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnDeviceCodeConfirmation.mdx @@ -0,0 +1,102 @@ +--- +title: "ScreenMembersOnDeviceCodeConfirmation" +--- + +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. + + + +```ts Example +export interface ScreenMembersOnDeviceCodeConfirmation extends ScreenMembers { + data: { + textCode: string; + } | null; +} +``` + + +- Extends [`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers) + +## Properties + +CaptchaContext}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#captcha) + + + + +{/*> **captchaImage**: `string` \| `null`*/} + +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 [`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#captchaimage) + + + + +{/*> **captchaProvider**: `string` \| `null`*/} + +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 [`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#captchaprovider) + + + + +{/*> **captchaSiteKey**: `string` \| `null`*/} + +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 [`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#captchasitekey) + + + + +{/*> **data**: \{ `textCode`: `string`; \} \| `null`*/} + +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 [`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#data) + + + + +{/*> **isCaptchaAvailable**: `boolean`*/} + +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 [`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#iscaptchaavailable) + + + + +{/*> **links**: `Record`\<`string`, `string`\> \| `null`*/} + +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 [`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#links) + + + + +{/*> **name**: `string`*/} + +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 [`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#name) + + + + +{/*> **texts**: `Record`\<`string`, `string`\> \| `null`*/} + +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 [`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#texts) + \ 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..a90a8c5f4 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnEmailIdentifierChallenge.mdx @@ -0,0 +1,102 @@ +--- +title: "ScreenMembersOnEmailIdentifierChallenge" +--- + +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) + + + +```ts Example +export interface ScreenMembersOnEmailIdentifierChallenge extends ScreenMembers { + data: { + messageType?: string; + email?: string; + resendLimitReached?: boolean; + } | null; +} +``` + + +- Extends [`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers) + +## Properties + +CaptchaContext}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#captcha) + + + + +{/*> **captchaImage**: `string` \| `null`*/} + +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 [`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#captchaimage) + + + + +{/*> **captchaProvider**: `string` \| `null`*/} + +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 [`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#captchaprovider) + + + + +{/*> **captchaSiteKey**: `string` \| `null`*/} + +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 [`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#captchasitekey) + + + + +{/*> **data**: \{ `email?`: `string`; `messageType?`: `string`; `resendLimitReached?`: `boolean`; \} \| `null`*/} + +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 [`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#data) + + + + +{/*> **isCaptchaAvailable**: `boolean`*/} + +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 [`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#iscaptchaavailable) + + + + +{/*> **links**: `Record`\<`string`, `string`\> \| `null`*/} + +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 [`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#links) + + + + +{/*> **name**: `string`*/} + +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 [`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#name) + + + + +{/*> **texts**: `Record`\<`string`, `string`\> \| `null`*/} + +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 [`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#texts) + \ 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..f2929e528 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnEmailOTPChallenge.mdx @@ -0,0 +1,101 @@ +--- +title: "ScreenMembersOnEmailOTPChallenge" +--- + +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. + + + +```ts Example +export interface ScreenMembersOnEmailOTPChallenge extends ScreenMembers { + // Add any specific members for this screen here +} +``` + + +- Extends [`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers) + +## Properties + +CaptchaContext}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#captcha) + + + + +{/*> **captchaImage**: `string` \| `null`*/} + +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 [`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#captchaimage) + + + + +{/*> **captchaProvider**: `string` \| `null`*/} + +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 [`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#captchaprovider) + + + + +{/*> **captchaSiteKey**: `string` \| `null`*/} + +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 [`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#captchasitekey) + + + +PasskeyCreate}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#data) + + + + +{/*> **isCaptchaAvailable**: `boolean`*/} + +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 [`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#iscaptchaavailable) + + + + +{/*> **links**: `Record`\<`string`, `string`\> \| `null`*/} + +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 [`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#links) + + + + +{/*> **name**: `string`*/} + +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 [`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#name) + + + + +{/*> **texts**: `Record`\<`string`, `string`\> \| `null`*/} + +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 [`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#texts) + \ 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..9020dcd3d --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnEmailVerificationResult.mdx @@ -0,0 +1,144 @@ +--- +title: "ScreenMembersOnEmailVerificationResult" +--- + +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 + + + +```ts Example +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; +} +``` + + +- Extends [`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers) + +## Properties + +CaptchaContext}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#captcha) + + + + +{/*> **captchaImage**: `string` \| `null`*/} + +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 [`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#captchaimage) + + + + +{/*> **captchaProvider**: `string` \| `null`*/} + +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 [`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#captchaprovider) + + + + +{/*> **captchaSiteKey**: `string` \| `null`*/} + +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 [`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#captchasitekey) + + + + +{/*> **data**: \{ `status`: `string`; \} \| `null`*/} + +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. + +#### 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#data) + + + + +{/*> **isCaptchaAvailable**: `boolean`*/} + +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 [`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#iscaptchaavailable) + + + + +{/*> **links**: `Record`\<`string`, `string`\> \| `null`*/} + +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. + +- 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#links) + + + + +{/*> **loginLink**: `string` \| `null`*/} + +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. + + + + +{/*> **name**: `string`*/} + +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 [`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#name) + + + + +{/*> **texts**: `Record`\<`string`, `string`\> \| `null`*/} + +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 [`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#texts) + \ 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..081287a6f --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnLogin.mdx @@ -0,0 +1,118 @@ +--- +title: "ScreenMembersOnLogin" +--- + +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 + + + +```ts Example +export interface ScreenMembersOnLogin extends ScreenMembers { + signupLink: string | null; + resetPasswordLink: string | null; + data: { + username?: string; + } | null; +} +``` + + +- Extends [`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers) + +## Properties + +CaptchaContext}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#captcha) + + + + +{/*> **captchaImage**: `string` \| `null`*/} + +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 [`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#captchaimage) + + + + +{/*> **captchaProvider**: `string` \| `null`*/} + +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 [`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#captchaprovider) + + + + +{/*> **captchaSiteKey**: `string` \| `null`*/} + +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 [`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#captchasitekey) + + + + +{/*> **data**: \{ `username?`: `string`; \} \| `null`*/} + +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 [`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#data) + + + + +{/*> **isCaptchaAvailable**: `boolean`*/} + +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 [`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#iscaptchaavailable) + + + + +{/*> **links**: `Record`\<`string`, `string`\> \| `null`*/} + +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 [`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#links) + + + + +{/*> **name**: `string`*/} + +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 [`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#name) + + + + +{/*> **resetPasswordLink**: `string` \| `null`*/} + +Defined in: [interfaces/screens/login.ts:21](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/login.ts#L21) + + + + +{/*> **signupLink**: `string` \| `null`*/} + +Defined in: [interfaces/screens/login.ts:20](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/login.ts#L20) + + + + +{/*> **texts**: `Record`\<`string`, `string`\> \| `null`*/} + +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 [`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#texts) + \ 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..8af54f8aa --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnLoginId.mdx @@ -0,0 +1,121 @@ +--- +title: "ScreenMembersOnLoginId" +--- + +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) + + + +```ts Example +export interface ScreenMembersOnLoginId extends ScreenMembers { + signupLink: string | null; + resetPasswordLink: string | null; + publicKey: PasskeyRead['public_key'] | null; +} +``` + + +- Extends [`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers) + +## Properties + +CaptchaContext}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#captcha) + + + + +{/*> **captchaImage**: `string` \| `null`*/} + +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 [`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#captchaimage) + + + + +{/*> **captchaProvider**: `string` \| `null`*/} + +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 [`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#captchaprovider) + + + + +{/*> **captchaSiteKey**: `string` \| `null`*/} + +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 [`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#captchasitekey) + + + +PasskeyCreate}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#data) + + + + +{/*> **isCaptchaAvailable**: `boolean`*/} + +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 [`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#iscaptchaavailable) + + + + +{/*> **links**: `Record`\<`string`, `string`\> \| `null`*/} + +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 [`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#links) + + + + +{/*> **name**: `string`*/} + +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 [`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#name) + + + +AllowCredential}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/login-id.ts#L34) + + + + +{/*> **resetPasswordLink**: `string` \| `null`*/} + +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) + + + + +{/*> **signupLink**: `string` \| `null`*/} + +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) + + + + +{/*> **texts**: `Record`\<`string`, `string`\> \| `null`*/} + +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 [`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#texts) + \ 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..115b8a5da --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnLoginPassword.mdx @@ -0,0 +1,124 @@ +--- +title: "ScreenMembersOnLoginPassword" +--- + +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) + + + +```ts Example +export interface ScreenMembersOnLoginPassword extends ScreenMembers { + signupLink: string | null; + resetPasswordLink: string | null; + editIdentifierLink: string | null; + data: { + username: string; + } | null; +} +``` + + +- Extends [`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers) + +## Properties + +CaptchaContext}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#captcha) + + + + +{/*> **captchaImage**: `string` \| `null`*/} + +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 [`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#captchaimage) + + + + +{/*> **captchaProvider**: `string` \| `null`*/} + +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 [`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#captchaprovider) + + + + +{/*> **captchaSiteKey**: `string` \| `null`*/} + +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 [`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#captchasitekey) + + + + +{/*> **data**: \{ `username`: `string`; \} \| `null`*/} + +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 [`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#data) + + + + +{/*> **editIdentifierLink**: `string` \| `null`*/} + +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) + + + + +{/*> **isCaptchaAvailable**: `boolean`*/} + +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 [`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#iscaptchaavailable) + + + + +{/*> **links**: `Record`\<`string`, `string`\> \| `null`*/} + +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 [`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#links) + + + + +{/*> **name**: `string`*/} + +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 [`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#name) + + + + +{/*> **resetPasswordLink**: `string` \| `null`*/} + +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) + + + + +{/*> **signupLink**: `string` \| `null`*/} + +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) + + + + +{/*> **texts**: `Record`\<`string`, `string`\> \| `null`*/} + +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 [`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#texts) + \ 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..b008b13e6 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnLoginPasswordlessEmailCode.mdx @@ -0,0 +1,125 @@ +--- +title: "ScreenMembersOnLoginPasswordlessEmailCode" +--- + +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) + + + +```ts Example +export interface ScreenMembersOnLoginPasswordlessEmailCode extends ScreenMembers { + editIdentifierLink: string | null; + resetPasswordLink: string | null; + signupLink: string | null; + data: { + email?: string; + username?: string; + } | null; +} +``` + + +- Extends [`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers) + +## Properties + +CaptchaContext}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#captcha) + + + + +{/*> **captchaImage**: `string` \| `null`*/} + +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 [`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#captchaimage) + + + + +{/*> **captchaProvider**: `string` \| `null`*/} + +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 [`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#captchaprovider) + + + + +{/*> **captchaSiteKey**: `string` \| `null`*/} + +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 [`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#captchasitekey) + + + + +{/*> **data**: \{ `email?`: `string`; `username?`: `string`; \} \| `null`*/} + +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 [`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#data) + + + + +{/*> **editIdentifierLink**: `string` \| `null`*/} + +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) + + + + +{/*> **isCaptchaAvailable**: `boolean`*/} + +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 [`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#iscaptchaavailable) + + + + +{/*> **links**: `Record`\<`string`, `string`\> \| `null`*/} + +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 [`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#links) + + + + +{/*> **name**: `string`*/} + +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 [`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#name) + + + + +{/*> **resetPasswordLink**: `string` \| `null`*/} + +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) + + + + +{/*> **signupLink**: `string` \| `null`*/} + +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) + + + + +{/*> **texts**: `Record`\<`string`, `string`\> \| `null`*/} + +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 [`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#texts) + \ 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..273d5297a --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnLoginPasswordlessSmsOtp.mdx @@ -0,0 +1,133 @@ +--- +title: "ScreenMembersOnLoginPasswordlessSmsOtp" +--- + +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) + + + +```ts Example +export interface ScreenMembersOnLoginPasswordlessSmsOtp extends ScreenMembers { + signupLink: string | null; + resetPasswordLink: string | null; + backLink: string | null; + data: { + username: string; + phone_number: string; + }; +} +``` + + +- Extends [`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers) + +## Properties + + +{/*> **backLink**: `string` \| `null`*/} + +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) + + + +CaptchaContext}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#captcha) + + + + +{/*> **captchaImage**: `string` \| `null`*/} + +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 [`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#captchaimage) + + + + +{/*> **captchaProvider**: `string` \| `null`*/} + +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 [`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#captchaprovider) + + + + +{/*> **captchaSiteKey**: `string` \| `null`*/} + +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 [`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#captchasitekey) + + + + +{/*> **data**: `object`*/} + +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 + +{/*> **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#data) + + + + +{/*> **isCaptchaAvailable**: `boolean`*/} + +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 [`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#iscaptchaavailable) + + + + +{/*> **links**: `Record`\<`string`, `string`\> \| `null`*/} + +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 [`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#links) + + + + +{/*> **name**: `string`*/} + +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 [`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#name) + + + + +{/*> **resetPasswordLink**: `string` \| `null`*/} + +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) + + + + +{/*> **signupLink**: `string` \| `null`*/} + +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) + + + + +{/*> **texts**: `Record`\<`string`, `string`\> \| `null`*/} + +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 [`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#texts) + \ 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..5494a5b36 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnMfaCountryCodes.mdx @@ -0,0 +1,115 @@ +--- +title: "ScreenMembersOnMfaCountryCodes" +--- + +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 + + + +```ts Example +export interface ScreenMembersOnMfaCountryCodes extends ScreenMembers { + data: { + /** List of available phone prefixes */ + phone_prefixes: PhonePrefix[]; + } | null; +} +``` + + +- Extends [`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers) + +## Properties + +CaptchaContext}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#captcha) + + + + +{/*> **captchaImage**: `string` \| `null`*/} + +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 [`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#captchaimage) + + + + +{/*> **captchaProvider**: `string` \| `null`*/} + +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 [`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#captchaprovider) + + + + +{/*> **captchaSiteKey**: `string` \| `null`*/} + +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 [`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#captchasitekey) + + + +PhonePrefix}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#data) + + + + +{/*> **isCaptchaAvailable**: `boolean`*/} + +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 [`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#iscaptchaavailable) + + + + +{/*> **links**: `Record`\<`string`, `string`\> \| `null`*/} + +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 [`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#links) + + + + +{/*> **name**: `string`*/} + +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 [`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#name) + + + + +{/*> **texts**: `Record`\<`string`, `string`\> \| `null`*/} + +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 [`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#texts) + \ 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..6ecad5786 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnMfaEmailChallenge.mdx @@ -0,0 +1,103 @@ +--- +title: "ScreenMembersOnMfaEmailChallenge" +--- + +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 + + + +```ts Example +export interface ScreenMembersOnMfaEmailChallenge extends ScreenMembers { + data: { + email: string; + showRememberDevice?: boolean; + } | null; +} +``` + + +- Extends [`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers) + +## Properties + +CaptchaContext}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#captcha) + + + + +{/*> **captchaImage**: `string` \| `null`*/} + +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 [`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#captchaimage) + + + + +{/*> **captchaProvider**: `string` \| `null`*/} + +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 [`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#captchaprovider) + + + + +{/*> **captchaSiteKey**: `string` \| `null`*/} + +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 [`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#captchasitekey) + + + + +{/*> **data**: \{ `email`: `string`; `showRememberDevice?`: `boolean`; \} \| `null`*/} + +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 [`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#data) + + + + +{/*> **isCaptchaAvailable**: `boolean`*/} + +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 [`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#iscaptchaavailable) + + + + +{/*> **links**: `Record`\<`string`, `string`\> \| `null`*/} + +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 [`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#links) + + + + +{/*> **name**: `string`*/} + +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 [`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#name) + + + + +{/*> **texts**: `Record`\<`string`, `string`\> \| `null`*/} + +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 [`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#texts) + \ 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..602313458 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnMfaEmailList.mdx @@ -0,0 +1,115 @@ +--- +title: "ScreenMembersOnMfaEmailList" +--- + +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 + + + +```ts Example +export interface ScreenMembersOnMfaEmailList extends ScreenMembers { + data: { + /** List of enrolled email addresses */ + enrolled_emails: string[]; + } | null; +} +``` + + +- Extends [`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers) + +## Properties + +CaptchaContext}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#captcha) + + + + +{/*> **captchaImage**: `string` \| `null`*/} + +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 [`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#captchaimage) + + + + +{/*> **captchaProvider**: `string` \| `null`*/} + +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 [`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#captchaprovider) + + + + +{/*> **captchaSiteKey**: `string` \| `null`*/} + +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 [`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#captchasitekey) + + + + +{/*> **data**: \{ `enrolled_emails`: `string`[]; \} \| `null`*/} + +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 + +\{ `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#data) + + + + +{/*> **isCaptchaAvailable**: `boolean`*/} + +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 [`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#iscaptchaavailable) + + + + +{/*> **links**: `Record`\<`string`, `string`\> \| `null`*/} + +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 [`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#links) + + + + +{/*> **name**: `string`*/} + +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 [`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#name) + + + + +{/*> **texts**: `Record`\<`string`, `string`\> \| `null`*/} + +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 [`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#texts) + \ 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..87e0d51d8 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnMfaEnrollResult.mdx @@ -0,0 +1,128 @@ +--- +title: "ScreenMembersOnMfaEnrollResult" +--- + +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 + + + +```ts Example +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; +} +``` + + +- Extends [`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers) + +## Properties + +CaptchaContext}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#captcha) + + + + +{/*> **captchaImage**: `string` \| `null`*/} + +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 [`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#captchaimage) + + + + +{/*> **captchaProvider**: `string` \| `null`*/} + +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 [`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#captchaprovider) + + + + +{/*> **captchaSiteKey**: `string` \| `null`*/} + +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 [`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#captchasitekey) + + + + +{/*> **data**: \{ `status`: `string`; \} \| `null`*/} + +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. + +#### 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#data) + + + + +{/*> **isCaptchaAvailable**: `boolean`*/} + +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 [`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#iscaptchaavailable) + + + + +{/*> **links**: `Record`\<`string`, `string`\> \| `null`*/} + +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 [`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#links) + + + + +{/*> **name**: `string`*/} + +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 [`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#name) + + + + +{/*> **texts**: `Record`\<`string`, `string`\> \| `null`*/} + +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 [`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#texts) + \ 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..85192f589 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnMfaLoginOptions.mdx @@ -0,0 +1,115 @@ +--- +title: "ScreenMembersOnMfaLoginOptions" +--- + +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 + + + +```ts Example +export interface ScreenMembersOnMfaLoginOptions extends ScreenMembers { + data: { + /** List of enrolled MFA factors for the user */ + enrolled_factors: string[]; + } | null; +} +``` + + +- Extends [`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers) + +## Properties + +CaptchaContext}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#captcha) + + + + +{/*> **captchaImage**: `string` \| `null`*/} + +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 [`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#captchaimage) + + + + +{/*> **captchaProvider**: `string` \| `null`*/} + +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 [`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#captchaprovider) + + + + +{/*> **captchaSiteKey**: `string` \| `null`*/} + +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 [`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#captchasitekey) + + + + +{/*> **data**: \{ `enrolled_factors`: `string`[]; \} \| `null`*/} + +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 + +\{ `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#data) + + + + +{/*> **isCaptchaAvailable**: `boolean`*/} + +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 [`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#iscaptchaavailable) + + + + +{/*> **links**: `Record`\<`string`, `string`\> \| `null`*/} + +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 [`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#links) + + + + +{/*> **name**: `string`*/} + +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 [`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#name) + + + + +{/*> **texts**: `Record`\<`string`, `string`\> \| `null`*/} + +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 [`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#texts) + \ 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..f06dee205 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnMfaOtpChallenge.mdx @@ -0,0 +1,102 @@ +--- +title: "ScreenMembersOnMfaOtpChallenge" +--- + +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 + + + +```ts Example +export interface ScreenMembersOnMfaOtpChallenge extends ScreenMembers { + data: { + showRememberDevice?: boolean; + } | null; +} +``` + + +- Extends [`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers) + +## Properties + +CaptchaContext}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#captcha) + + + + +{/*> **captchaImage**: `string` \| `null`*/} + +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 [`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#captchaimage) + + + + +{/*> **captchaProvider**: `string` \| `null`*/} + +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 [`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#captchaprovider) + + + + +{/*> **captchaSiteKey**: `string` \| `null`*/} + +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 [`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#captchasitekey) + + + + +{/*> **data**: \{ `showRememberDevice?`: `boolean`; \} \| `null`*/} + +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 [`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#data) + + + + +{/*> **isCaptchaAvailable**: `boolean`*/} + +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 [`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#iscaptchaavailable) + + + + +{/*> **links**: `Record`\<`string`, `string`\> \| `null`*/} + +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 [`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#links) + + + + +{/*> **name**: `string`*/} + +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 [`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#name) + + + + +{/*> **texts**: `Record`\<`string`, `string`\> \| `null`*/} + +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 [`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#texts) + \ 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..0ca36420a --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnMfaOtpEnrollmentCode.mdx @@ -0,0 +1,117 @@ +--- +title: "ScreenMembersOnMfaOtpEnrollmentCode" +--- + +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. + + + +```ts Example +export interface ScreenMembersOnMfaOtpEnrollmentCode extends ScreenMembers { + data: { + /** + * The text code to display to the user. + */ + text_code: string; + } | null; +} +``` + + +- Extends [`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers) + +## Properties + +CaptchaContext}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#captcha) + + + + +{/*> **captchaImage**: `string` \| `null`*/} + +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 [`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#captchaimage) + + + + +{/*> **captchaProvider**: `string` \| `null`*/} + +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 [`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#captchaprovider) + + + + +{/*> **captchaSiteKey**: `string` \| `null`*/} + +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 [`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#captchasitekey) + + + + +{/*> **data**: \{ `text_code`: `string`; \} \| `null`*/} + +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 + +\{ `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#data) + + + + +{/*> **isCaptchaAvailable**: `boolean`*/} + +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 [`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#iscaptchaavailable) + + + + +{/*> **links**: `Record`\<`string`, `string`\> \| `null`*/} + +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 [`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#links) + + + + +{/*> **name**: `string`*/} + +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 [`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#name) + + + + +{/*> **texts**: `Record`\<`string`, `string`\> \| `null`*/} + +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 [`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#texts) + \ 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..dea452faf --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnMfaOtpEnrollmentQr.mdx @@ -0,0 +1,102 @@ +--- +title: "ScreenMembersOnMfaOtpEnrollmentQr" +--- + +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 + + + +```ts Example +export interface ScreenMembersOnMfaOtpEnrollmentQr extends ScreenMembers { + data: { + qr_code: string; + } | null; +} +``` + + +- Extends [`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers) + +## Properties + +CaptchaContext}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#captcha) + + + + +{/*> **captchaImage**: `string` \| `null`*/} + +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 [`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#captchaimage) + + + + +{/*> **captchaProvider**: `string` \| `null`*/} + +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 [`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#captchaprovider) + + + + +{/*> **captchaSiteKey**: `string` \| `null`*/} + +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 [`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#captchasitekey) + + + + +{/*> **data**: \{ `qr_code`: `string`; \} \| `null`*/} + +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 [`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#data) + + + + +{/*> **isCaptchaAvailable**: `boolean`*/} + +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 [`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#iscaptchaavailable) + + + + +{/*> **links**: `Record`\<`string`, `string`\> \| `null`*/} + +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 [`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#links) + + + + +{/*> **name**: `string`*/} + +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 [`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#name) + + + + +{/*> **texts**: `Record`\<`string`, `string`\> \| `null`*/} + +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 [`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#texts) + \ 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..e23f62f9c --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnMfaPhoneChallenge.mdx @@ -0,0 +1,119 @@ +--- +title: "ScreenMembersOnMfaPhoneChallenge" +--- + +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 + + + +```ts Example +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; +} +``` + + +- Extends [`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers) + +## Properties + +CaptchaContext}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#captcha) + + + + +{/*> **captchaImage**: `string` \| `null`*/} + +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 [`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#captchaimage) + + + + +{/*> **captchaProvider**: `string` \| `null`*/} + +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 [`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#captchaprovider) + + + + +{/*> **captchaSiteKey**: `string` \| `null`*/} + +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 [`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#captchasitekey) + + + + +{/*> **data**: \{ `phoneNumber`: `string`; \} \| `null`*/} + +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 + +\{ `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#data) + + + + +{/*> **isCaptchaAvailable**: `boolean`*/} + +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 [`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#iscaptchaavailable) + + + + +{/*> **links**: `Record`\<`string`, `string`\> \| `null`*/} + +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 [`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#links) + + + + +{/*> **name**: `string`*/} + +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 [`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#name) + + + + +{/*> **texts**: `Record`\<`string`, `string`\> \| `null`*/} + +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 [`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#texts) + \ 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..2f20d2bd4 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnMfaPushChallengePush.mdx @@ -0,0 +1,123 @@ +--- +title: "ScreenMembersOnMfaPushChallengePush" +--- + +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 + + + +```ts Example +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; +} +``` + + +- Extends [`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers) + +## Properties + +CaptchaContext}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#captcha) + + + + +{/*> **captchaImage**: `string` \| `null`*/} + +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 [`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#captchaimage) + + + + +{/*> **captchaProvider**: `string` \| `null`*/} + +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 [`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#captchaprovider) + + + + +{/*> **captchaSiteKey**: `string` \| `null`*/} + +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 [`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#captchasitekey) + + + + +{/*> **data**: \{ `deviceName`: `string`; `showRememberDevice?`: `boolean`; \} \| `null`*/} + +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 + +\{ `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#data) + + + + +{/*> **isCaptchaAvailable**: `boolean`*/} + +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 [`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#iscaptchaavailable) + + + + +{/*> **links**: `Record`\<`string`, `string`\> \| `null`*/} + +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 [`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#links) + + + + +{/*> **name**: `string`*/} + +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 [`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#name) + + + + +{/*> **texts**: `Record`\<`string`, `string`\> \| `null`*/} + +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 [`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#texts) + \ 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..e8911663f --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnMfaPushEnrollmentQr.mdx @@ -0,0 +1,104 @@ +--- +title: "ScreenMembersOnMfaPushEnrollmentQr" +--- + +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 + + + +```ts Example +export interface ScreenMembersOnMfaPushEnrollmentQr extends ScreenMembers { + data: { + qrCode: string; + qrUri: string; + showCodeCopy: boolean; + } | null; +} +``` + + +- Extends [`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers) + +## Properties + +CaptchaContext}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#captcha) + + + + +{/*> **captchaImage**: `string` \| `null`*/} + +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 [`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#captchaimage) + + + + +{/*> **captchaProvider**: `string` \| `null`*/} + +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 [`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#captchaprovider) + + + + +{/*> **captchaSiteKey**: `string` \| `null`*/} + +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 [`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#captchasitekey) + + + + +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#data) + + + + +{/*> **isCaptchaAvailable**: `boolean`*/} + +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 [`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#iscaptchaavailable) + + + + +{/*> **links**: `Record`\<`string`, `string`\> \| `null`*/} + +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 [`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#links) + + + + +{/*> **name**: `string`*/} + +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 [`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#name) + + + + +{/*> **texts**: `Record`\<`string`, `string`\> \| `null`*/} + +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 [`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#texts) + \ 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..5e6c50a9d --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnMfaPushWelcome.mdx @@ -0,0 +1,127 @@ +--- +title: "ScreenMembersOnMfaPushWelcome" +--- + +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) + + + +```ts Example +export interface ScreenMembersOnMfaPushWelcome extends ScreenMembers { + screen: { + name: string; + links: { + ios: string; + android: string; + }; + }; +} +``` + + +- Extends [`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers) + +## Properties + +CaptchaContext}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#captcha) + + + + +{/*> **captchaImage**: `string` \| `null`*/} + +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 [`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#captchaimage) + + + + +{/*> **captchaProvider**: `string` \| `null`*/} + +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 [`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#captchaprovider) + + + + +{/*> **captchaSiteKey**: `string` \| `null`*/} + +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 [`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#captchasitekey) + + + +PasskeyCreate}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#data) + + + + +{/*> **isCaptchaAvailable**: `boolean`*/} + +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 [`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#iscaptchaavailable) + + + + +{/*> **links**: `Record`\<`string`, `string`\> \| `null`*/} + +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 [`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#links) + + + + +{/*> **name**: `string`*/} + +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 [`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#name) + + + + +{/*> **screen**: `object`*/} + +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 + +{/*> **links**: `object`*/} + +##### links.android + +{/*> **android**: `string`*/} + +##### links.ios + +{/*> **ios**: `string`*/} + +#### name + +{/*> **name**: `string`*/} + + + + +{/*> **texts**: `Record`\<`string`, `string`\> \| `null`*/} + +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 [`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#texts) + \ 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..fe430133c --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnMfaRecoveryCodeChallengeNewCode.mdx @@ -0,0 +1,123 @@ +--- +title: "ScreenMembersOnMfaRecoveryCodeChallengeNewCode" +--- + +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 + + + +```ts Example +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; +} +``` + + +- Extends [`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers) + +## Properties + +CaptchaContext}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#captcha) + + + + +{/*> **captchaImage**: `string` \| `null`*/} + +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 [`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#captchaimage) + + + + +{/*> **captchaProvider**: `string` \| `null`*/} + +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 [`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#captchaprovider) + + + + +{/*> **captchaSiteKey**: `string` \| `null`*/} + +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 [`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#captchasitekey) + + + + +{/*> **data**: \{ `textCode`: `string`; \} \| `null`*/} + +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 + +\{ `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#data) + + + + +{/*> **isCaptchaAvailable**: `boolean`*/} + +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 [`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#iscaptchaavailable) + + + + +{/*> **links**: `Record`\<`string`, `string`\> \| `null`*/} + +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 [`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#links) + + + + +{/*> **name**: `string`*/} + +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 [`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#name) + + + + +{/*> **texts**: `Record`\<`string`, `string`\> \| `null`*/} + +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 [`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#texts) + \ 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..e71d1739c --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnMfaRecoveryCodeEnrollment.mdx @@ -0,0 +1,117 @@ +--- +title: "ScreenMembersOnMfaRecoveryCodeEnrollment" +--- + +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. + + + +```ts Example +export interface ScreenMembersOnMfaRecoveryCodeEnrollment extends ScreenMembers { + data: { + /** + * The recovery code to display to the user. + */ + textCode: string; + } | null; +} +``` + + +- Extends [`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers) + +## Properties + +CaptchaContext}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#captcha) + + + + +{/*> **captchaImage**: `string` \| `null`*/} + +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 [`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#captchaimage) + + + + +{/*> **captchaProvider**: `string` \| `null`*/} + +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 [`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#captchaprovider) + + + + +{/*> **captchaSiteKey**: `string` \| `null`*/} + +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 [`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#captchasitekey) + + + + +{/*> **data**: \{ `textCode`: `string`; \} \| `null`*/} + +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 + +\{ `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#data) + + + + +{/*> **isCaptchaAvailable**: `boolean`*/} + +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 [`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#iscaptchaavailable) + + + + +{/*> **links**: `Record`\<`string`, `string`\> \| `null`*/} + +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 [`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#links) + + + + +{/*> **name**: `string`*/} + +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 [`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#name) + + + + +{/*> **texts**: `Record`\<`string`, `string`\> \| `null`*/} + +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 [`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#texts) + \ 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..9ff4ba07c --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnMfaSmsChallenge.mdx @@ -0,0 +1,137 @@ +--- +title: "ScreenMembersOnMfaSmsChallenge" +--- + +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 + + + +```ts Example +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; +} +``` + + +- Extends [`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers) + +## Properties + +CaptchaContext}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#captcha) + + + + +{/*> **captchaImage**: `string` \| `null`*/} + +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 [`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#captchaimage) + + + + +{/*> **captchaProvider**: `string` \| `null`*/} + +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 [`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#captchaprovider) + + + + +{/*> **captchaSiteKey**: `string` \| `null`*/} + +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 [`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#captchasitekey) + + + + +{/*> **data**: \{ `phoneNumber?`: `string`; `showLinkVoice?`: `boolean`; `showRememberDevice?`: `boolean`; \} \| `null`*/} + +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 + +\{ `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#data) + + + + +{/*> **isCaptchaAvailable**: `boolean`*/} + +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 [`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#iscaptchaavailable) + + + + +{/*> **links**: `Record`\<`string`, `string`\> \| `null`*/} + +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 [`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#links) + + + + +{/*> **name**: `string`*/} + +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 [`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#name) + + + + +{/*> **texts**: `Record`\<`string`, `string`\> \| `null`*/} + +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 [`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#texts) + \ 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..b28780b53 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnMfaSmsEnrollment.mdx @@ -0,0 +1,100 @@ +--- +title: "ScreenMembersOnMfaSmsEnrollment" +--- + +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) + + + +```ts Example +export interface ScreenMembersOnMfaSmsEnrollment extends ScreenMembers { + data: { + phone?: string; + } | null; +} +``` + + +- Extends [`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers) + +## Properties + +CaptchaContext}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#captcha) + + + + +{/*> **captchaImage**: `string` \| `null`*/} + +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 [`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#captchaimage) + + + + +{/*> **captchaProvider**: `string` \| `null`*/} + +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 [`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#captchaprovider) + + + + +{/*> **captchaSiteKey**: `string` \| `null`*/} + +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 [`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#captchasitekey) + + + + +{/*> **data**: \{ `phone?`: `string`; \} \| `null`*/} + +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 [`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#data) + + + + +{/*> **isCaptchaAvailable**: `boolean`*/} + +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 [`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#iscaptchaavailable) + + + + +{/*> **links**: `Record`\<`string`, `string`\> \| `null`*/} + +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 [`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#links) + + + + +{/*> **name**: `string`*/} + +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 [`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#name) + + + + +{/*> **texts**: `Record`\<`string`, `string`\> \| `null`*/} + +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 [`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#texts) + \ 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..cc1e96672 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnMfaVoiceChallenge.mdx @@ -0,0 +1,144 @@ +--- +title: "ScreenMembersOnMfaVoiceChallenge" +--- + +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. + + + +```ts Example +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; +} +``` + + +- Extends [`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers) + +## Properties + +CaptchaContext}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#captcha) + + + + +{/*> **captchaImage**: `string` \| `null`*/} + +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 [`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#captchaimage) + + + + +{/*> **captchaProvider**: `string` \| `null`*/} + +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 [`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#captchaprovider) + + + + +{/*> **captchaSiteKey**: `string` \| `null`*/} + +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 [`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#captchasitekey) + + + + +{/*> **data**: \{ `phoneNumber?`: `string`; `showLinkSms?`: `boolean`; `showRememberDevice?`: `boolean`; \} \| `null`*/} + +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. + +#### 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#data) + + + + +{/*> **isCaptchaAvailable**: `boolean`*/} + +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 [`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#iscaptchaavailable) + + + + +{/*> **links**: `Record`\<`string`, `string`\> \| `null`*/} + +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 [`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#links) + + + + +{/*> **name**: `string`*/} + +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 [`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#name) + + + + +{/*> **texts**: `Record`\<`string`, `string`\> \| `null`*/} + +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 [`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#texts) + \ 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..248a06071 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnMfaWebAuthnChangeKeyNickname.mdx @@ -0,0 +1,139 @@ +--- +title: "ScreenMembersOnMfaWebAuthnChangeKeyNickname" +--- + +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 + + + +```ts Example +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; +} +``` + + +- Extends [`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers) + +## Properties + +CaptchaContext}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#captcha) + + + + +{/*> **captchaImage**: `string` \| `null`*/} + +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 [`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#captchaimage) + + + + +{/*> **captchaProvider**: `string` \| `null`*/} + +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 [`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#captchaprovider) + + + + +{/*> **captchaSiteKey**: `string` \| `null`*/} + +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 [`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#captchasitekey) + + + + +{/*> **data**: \{ `nickname`: `string`; \} \| `null`*/} + +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. + +- Type Declaration: `{ 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. + + +```ts Example 1 +"My YubiKey" +``` + +```ts Example 2 +"Work Security Key" +``` +```ts Example 3 +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#data) + + + + + + +{/*> **isCaptchaAvailable**: `boolean`*/} + +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 [`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#iscaptchaavailable) + + + + +{/*> **links**: `Record`\<`string`, `string`\> \| `null`*/} + +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 [`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#links) + + + + +{/*> **name**: `string`*/} + +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 [`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#name) + + + + +{/*> **texts**: `Record`\<`string`, `string`\> \| `null`*/} + +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 [`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#texts) + \ 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..915a0a67d --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnMfaWebAuthnEnrollmentSuccess.mdx @@ -0,0 +1,154 @@ +--- +title: "ScreenMembersOnMfaWebAuthnEnrollmentSuccess" +--- + +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 + + + +```ts Example +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; +} +``` + + +- Extends [`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers) + +## Properties + +CaptchaContext}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#captcha) + + + + +{/*> **captchaImage**: `string` \| `null`*/} + +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 [`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#captchaimage) + + + + +{/*> **captchaProvider**: `string` \| `null`*/} + +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 [`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#captchaprovider) + + + + +{/*> **captchaSiteKey**: `string` \| `null`*/} + +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 [`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#captchasitekey) + + + +WebAuthnType}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/mfa-webauthn-enrollment-success.ts#L22) + +Screen-specific data. + +- Type Declaration: `{ nickname: string; webauthnType: [WebAuthnType]; }` + + + +{/*> **nickname**: `string`*/} + +The nickname that the user (or system) assigned to the newly enrolled WebAuthn authenticator. +This helps the user identify the authenticator later. + + +```ts Example 1 +"YubiKey 5" +``` + +```ts Example 2 +"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#data) + + + + +{/*> **isCaptchaAvailable**: `boolean`*/} + +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 [`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#iscaptchaavailable) + + + + +{/*> **links**: `Record`\<`string`, `string`\> \| `null`*/} + +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 [`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#links) + + + + +{/*> **name**: `string`*/} + +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 [`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#name) + + + + +{/*> **texts**: `Record`\<`string`, `string`\> \| `null`*/} + +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 [`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#texts) + \ 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..cda277af9 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnMfaWebAuthnError.mdx @@ -0,0 +1,134 @@ +--- +title: "ScreenMembersOnMfaWebAuthnError" +--- + +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 + + + +```ts Example +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; +} +``` + + +- Extends [`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers) + +## Properties + +CaptchaContext}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#captcha) + + + + +{/*> **captchaImage**: `string` \| `null`*/} + +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 [`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#captchaimage) + + + + +{/*> **captchaProvider**: `string` \| `null`*/} + +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 [`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#captchaprovider) + + + + +{/*> **captchaSiteKey**: `string` \| `null`*/} + +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 [`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#captchasitekey) + + + +WebAuthnType}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#data) + + + + +{/*> **isCaptchaAvailable**: `boolean`*/} + +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 [`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#iscaptchaavailable) + + + + +{/*> **links**: `Record`\<`string`, `string`\> \| `null`*/} + +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 [`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#links) + + + + +{/*> **name**: `string`*/} + +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 [`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#name) + + + + +{/*> **texts**: `Record`\<`string`, `string`\> \| `null`*/} + +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 [`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#texts) + \ 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..aed60d287 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnMfaWebAuthnPlatformChallenge.mdx @@ -0,0 +1,133 @@ +--- +title: "ScreenMembersOnMfaWebAuthnPlatformChallenge" +--- + +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 + + + +```ts Example +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; +} +``` + + +- Extends [`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers) + +## Properties + +CaptchaContext}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#captcha) + + + + +{/*> **captchaImage**: `string` \| `null`*/} + +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 [`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#captchaimage) + + + + +{/*> **captchaProvider**: `string` \| `null`*/} + +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 [`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#captchaprovider) + + + + +{/*> **captchaSiteKey**: `string` \| `null`*/} + +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 [`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#captchasitekey) + + + +PasskeyCreate}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#data) + + + + +{/*> **isCaptchaAvailable**: `boolean`*/} + +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 [`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#iscaptchaavailable) + + + + +{/*> **links**: `Record`\<`string`, `string`\> \| `null`*/} + +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 [`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#links) + + + + +{/*> **name**: `string`*/} + +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 [`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#name) + + + +AllowCredential}> +{/*> **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/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`. + + + + +{/*> **showRememberDevice**: `boolean`*/} + +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. + + + + +{/*> **texts**: `Record`\<`string`, `string`\> \| `null`*/} + +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 [`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#texts) + \ 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..7d6f41fd9 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnMfaWebAuthnPlatformEnrollment.mdx @@ -0,0 +1,112 @@ +--- +title: "ScreenMembersOnMfaWebAuthnPlatformEnrollment" +--- + +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 + + + +```ts Example +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; +} +``` + + +- Extends [`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers) + +## Properties + +CaptchaContext}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#captcha) + + + + +{/*> **captchaImage**: `string` \| `null`*/} + +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 [`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#captchaimage) + + + + +{/*> **captchaProvider**: `string` \| `null`*/} + +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 [`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#captchaprovider) + + + + +{/*> **captchaSiteKey**: `string` \| `null`*/} + +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 [`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#captchasitekey) + + + +PasskeyCreate}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#data) + + + + +{/*> **isCaptchaAvailable**: `boolean`*/} + +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 [`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#iscaptchaavailable) + + + + +{/*> **links**: `Record`\<`string`, `string`\> \| `null`*/} + +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 [`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#links) + + + + +{/*> **name**: `string`*/} + +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 [`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#name) + + + + +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/mfa-webauthn-platform-enrollment.ts#L17) + + + + +{/*> **texts**: `Record`\<`string`, `string`\> \| `null`*/} + +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 [`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#texts) + \ 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..56048eb49 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnMfaWebAuthnRoamingChallenge.mdx @@ -0,0 +1,125 @@ +--- +title: "ScreenMembersOnMfaWebAuthnRoamingChallenge" +--- + +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 + + + +```ts Example +export interface ScreenMembersOnMfaWebAuthnRoamingChallenge extends ScreenMembers { + showRememberDevice?: boolean; + webauthnType: string | null; + publicKey: PasskeyRead['public_key'] | null; +} +``` + + +- Extends [`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers) + +## Properties + +CaptchaContext}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#captcha) + + + + +{/*> **captchaImage**: `string` \| `null`*/} + +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 [`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#captchaimage) + + + + +{/*> **captchaProvider**: `string` \| `null`*/} + +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 [`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#captchaprovider) + + + + +{/*> **captchaSiteKey**: `string` \| `null`*/} + +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 [`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#captchasitekey) + + + +PasskeyCreate}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#data) + + + + +{/*> **isCaptchaAvailable**: `boolean`*/} + +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 [`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#iscaptchaavailable) + + + + +{/*> **links**: `Record`\<`string`, `string`\> \| `null`*/} + +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 [`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#links) + + + + +{/*> **name**: `string`*/} + +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 [`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#name) + + + +AllowCredential}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/mfa-webauthn-roaming-challenge.ts#L20) + + + + +{/*> `optional` **showRememberDevice**: `boolean`*/} + +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) + + + + +{/*> **texts**: `Record`\<`string`, `string`\> \| `null`*/} + +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 [`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#texts) + + + + +{/*> **webauthnType**: `string` \| `null`*/} + +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) + \ 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..baedcddc4 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnMfaWebAuthnRoamingEnrollment.mdx @@ -0,0 +1,115 @@ +--- +title: "ScreenMembersOnMfaWebAuthnRoamingEnrollment" +--- + +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. + + + +```ts Example +export interface ScreenMembersOnMfaWebAuthnRoamingEnrollment extends ScreenMembers { + webauthnType: string | null; + publicKey: PasskeyCreate['public_key'] | null; +} +``` + + +- Extends [`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers) + +## Properties + +CaptchaContext}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#captcha) + + + + +{/*> **captchaImage**: `string` \| `null`*/} + +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 [`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#captchaimage) + + + + +{/*> **captchaProvider**: `string` \| `null`*/} + +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 [`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#captchaprovider) + + + + +{/*> **captchaSiteKey**: `string` \| `null`*/} + +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 [`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#captchasitekey) + + + +PasskeyCreate}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#data) + + + + +{/*> **isCaptchaAvailable**: `boolean`*/} + +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 [`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#iscaptchaavailable) + + + + +{/*> **links**: `Record`\<`string`, `string`\> \| `null`*/} + +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 [`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#links) + + + + +{/*> **name**: `string`*/} + +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 [`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#name) + + + + +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/mfa-webauthn-roaming-enrollment.ts#L9) + + + + +{/*> **texts**: `Record`\<`string`, `string`\> \| `null`*/} + +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 [`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#texts) + + + + +{/*> **webauthnType**: `string` \| `null`*/} + +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) + \ 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..d5ce59392 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnOrganizationSelection.mdx @@ -0,0 +1,147 @@ +--- +title: "ScreenMembersOnOrganizationSelection" +--- + +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. + + + +```ts Example +export interface ScreenMembersOnOrganizationSelection extends ScreenMembers { + client: ClientMembers; + organization: OrganizationMembers; + prompt: PromptMembers; + screen: ScreenMembers; + transaction: TransactionMembers; + User: UserMembers; +} +``` + + +- Extends [`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers) + +## Properties + +CaptchaContext}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#captcha) + + + + +{/*> **captchaImage**: `string` \| `null`*/} + +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 [`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#captchaimage) + + + + +{/*> **captchaProvider**: `string` \| `null`*/} + +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 [`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#captchaprovider) + + + + +{/*> **captchaSiteKey**: `string` \| `null`*/} + +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 [`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#captchasitekey) + + + +ClientMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/organization-selection.ts#L27) + + + +PasskeyCreate}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#data) + + + + +{/*> **isCaptchaAvailable**: `boolean`*/} + +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 [`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#iscaptchaavailable) + + + + +{/*> **links**: `Record`\<`string`, `string`\> \| `null`*/} + +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 [`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#links) + + + + +{/*> **name**: `string`*/} + +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 [`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#name) + + + +OrganizationMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/organization-selection.ts#L28) + + + +PromptMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/organization-selection.ts#L29) + + + +ScreenMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/organization-selection.ts#L30) + + + + +{/*> **texts**: `Record`\<`string`, `string`\> \| `null`*/} + +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 [`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#texts) + + + +TransactionMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/organization-selection.ts#L31) + + + +UserMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/organization-selection.ts#L32) + \ 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..1087288ce --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnPasskeyEnrollment.mdx @@ -0,0 +1,121 @@ +--- +title: "ScreenMembersOnPasskeyEnrollment" +--- + +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) + + + +```ts Example +export interface ScreenMembersOnPasskeyEnrollment extends ScreenMembers { + backLink: string | null; + loginLink: string | null; + publicKey: PasskeyCreate['public_key'] | null; +} +``` + + +- Extends [`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers) + +## Properties + + +{/*> **backLink**: `string` \| `null`*/} + +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) + + + +CaptchaContext}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#captcha) + + + + +{/*> **captchaImage**: `string` \| `null`*/} + +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 [`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#captchaimage) + + + + +{/*> **captchaProvider**: `string` \| `null`*/} + +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 [`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#captchaprovider) + + + + +{/*> **captchaSiteKey**: `string` \| `null`*/} + +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 [`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#captchasitekey) + + + +PasskeyCreate}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#data) + + + + +{/*> **isCaptchaAvailable**: `boolean`*/} + +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 [`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#iscaptchaavailable) + + + + +{/*> **links**: `Record`\<`string`, `string`\> \| `null`*/} + +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 [`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#links) + + + + +{/*> **loginLink**: `string` \| `null`*/} + +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) + + + + +{/*> **name**: `string`*/} + +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 [`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#name) + + + + +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/passkey-enrollment.ts#L22) + + + + +{/*> **texts**: `Record`\<`string`, `string`\> \| `null`*/} + +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 [`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#texts) + \ 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..06fa553d3 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnPasskeyEnrollmentLocal.mdx @@ -0,0 +1,105 @@ +--- +title: "ScreenMembersOnPasskeyEnrollmentLocal" +--- + +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) + + + +```ts Example +export interface ScreenMembersOnPasskeyEnrollmentLocal extends ScreenMembers { + publicKey: PasskeyCreate['public_key'] | null; +} +``` + + +- Extends [`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers) + +## Properties + +CaptchaContext}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#captcha) + + + + +{/*> **captchaImage**: `string` \| `null`*/} + +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 [`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#captchaimage) + + + + +{/*> **captchaProvider**: `string` \| `null`*/} + +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 [`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#captchaprovider) + + + + +{/*> **captchaSiteKey**: `string` \| `null`*/} + +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 [`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#captchasitekey) + + + +PasskeyCreate}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#data) + + + + +{/*> **isCaptchaAvailable**: `boolean`*/} + +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 [`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#iscaptchaavailable) + + + + +{/*> **links**: `Record`\<`string`, `string`\> \| `null`*/} + +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 [`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#links) + + + + +{/*> **name**: `string`*/} + +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 [`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#name) + + + + +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/passkey-enrollment-local.ts#L25) + + + + +{/*> **texts**: `Record`\<`string`, `string`\> \| `null`*/} + +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 [`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#texts) + \ 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..021ca1b41 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnPhoneIdentifierChallenge.mdx @@ -0,0 +1,104 @@ +--- +title: "ScreenMembersOnPhoneIdentifierChallenge" +--- + +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) + + + +```ts Example +export interface ScreenMembersOnPhoneIdentifierChallenge extends ScreenMembers { + data: { + messageType?: 'text' | 'voice'; + phone?: string; + resendLimitReached?: boolean; + showLinkSms?: boolean; + showLinkVoice?: boolean; + } | null; +} +``` + + +- Extends [`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers) + +## Properties + +CaptchaContext}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#captcha) + + + + +{/*> **captchaImage**: `string` \| `null`*/} + +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 [`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#captchaimage) + + + + +{/*> **captchaProvider**: `string` \| `null`*/} + +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 [`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#captchaprovider) + + + + +{/*> **captchaSiteKey**: `string` \| `null`*/} + +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 [`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#captchasitekey) + + + + +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#data) + + + + +{/*> **isCaptchaAvailable**: `boolean`*/} + +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 [`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#iscaptchaavailable) + + + + +{/*> **links**: `Record`\<`string`, `string`\> \| `null`*/} + +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 [`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#links) + + + + +{/*> **name**: `string`*/} + +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 [`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#name) + + + + +{/*> **texts**: `Record`\<`string`, `string`\> \| `null`*/} + +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 [`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#texts) + \ 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..9b110eed0 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnPhoneIdentifierEnrollment.mdx @@ -0,0 +1,109 @@ +--- +title: "ScreenMembersOnPhoneIdentifierEnrollment" +--- + +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) + + + +```ts Example +export interface ScreenMembersOnPhoneIdentifierEnrollment extends ScreenMembers { + data: { + phone?: 'string'; + messageType?: 'text' | 'voice'; + } | null; + editIdentifierLink: string | null; +} +``` + + +- Extends [`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers) + +## Properties + +CaptchaContext}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#captcha) + + + + +{/*> **captchaImage**: `string` \| `null`*/} + +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 [`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#captchaimage) + + + + +{/*> **captchaProvider**: `string` \| `null`*/} + +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 [`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#captchaprovider) + + + + +{/*> **captchaSiteKey**: `string` \| `null`*/} + +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 [`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#captchasitekey) + + + + +{/*> **data**: \{ `messageType?`: `"voice"` \| `"text"`; `phone?`: `"string"`; \} \| `null`*/} + +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 [`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#data) + + + + +{/*> **editIdentifierLink**: `string` \| `null`*/} + +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) + + + + +{/*> **isCaptchaAvailable**: `boolean`*/} + +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 [`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#iscaptchaavailable) + + + + +{/*> **links**: `Record`\<`string`, `string`\> \| `null`*/} + +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 [`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#links) + + + + +{/*> **name**: `string`*/} + +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 [`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#name) + + + + +{/*> **texts**: `Record`\<`string`, `string`\> \| `null`*/} + +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 [`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#texts) + \ 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..2894abbe9 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnResetPassword.mdx @@ -0,0 +1,100 @@ +--- +title: "ScreenMembersOnResetPassword" +--- + +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) + + + +```ts Example +export interface ScreenMembersOnResetPassword extends ScreenMembers { + data: { + username?: string; + } | null; +} +``` + + +- Extends [`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers) + +## Properties + +CaptchaContext}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#captcha) + + + + +{/*> **captchaImage**: `string` \| `null`*/} + +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 [`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#captchaimage) + + + + +{/*> **captchaProvider**: `string` \| `null`*/} + +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 [`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#captchaprovider) + + + + +{/*> **captchaSiteKey**: `string` \| `null`*/} + +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 [`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#captchasitekey) + + + + +{/*> **data**: \{ `username?`: `string`; \} \| `null`*/} + +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 [`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#data) + + + + +{/*> **isCaptchaAvailable**: `boolean`*/} + +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 [`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#iscaptchaavailable) + + + + +{/*> **links**: `Record`\<`string`, `string`\> \| `null`*/} + +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 [`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#links) + + + + +{/*> **name**: `string`*/} + +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 [`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#name) + + + + +{/*> **texts**: `Record`\<`string`, `string`\> \| `null`*/} + +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 [`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#texts) + \ 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..fe4f65434 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnResetPasswordEmail.mdx @@ -0,0 +1,100 @@ +--- +title: "ScreenMembersOnResetPasswordEmail" +--- + +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) + + + +```ts Example +export interface ScreenMembersOnResetPasswordEmail extends ScreenMembers { + data: { + username?: string; + } | null; +} +``` + + +- Extends [`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers) + +## Properties + +CaptchaContext}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#captcha) + + + + +{/*> **captchaImage**: `string` \| `null`*/} + +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 [`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#captchaimage) + + + + +{/*> **captchaProvider**: `string` \| `null`*/} + +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 [`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#captchaprovider) + + + + +{/*> **captchaSiteKey**: `string` \| `null`*/} + +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 [`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#captchasitekey) + + + + +{/*> **data**: \{ `username?`: `string`; \} \| `null`*/} + +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 [`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#data) + + + + +{/*> **isCaptchaAvailable**: `boolean`*/} + +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 [`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#iscaptchaavailable) + + + + +{/*> **links**: `Record`\<`string`, `string`\> \| `null`*/} + +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 [`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#links) + + + + +{/*> **name**: `string`*/} + +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 [`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#name) + + + + +{/*> **texts**: `Record`\<`string`, `string`\> \| `null`*/} + +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 [`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#texts) + \ 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..db4c537c4 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnResetPasswordError.mdx @@ -0,0 +1,100 @@ +--- +title: "ScreenMembersOnResetPasswordError" +--- + +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) + + + +```ts Example +export interface ScreenMembersOnResetPasswordError extends ScreenMembers { + data: { + username?: string; + } | null; +} +``` + + +- Extends [`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers) + +## Properties + +CaptchaContext}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#captcha) + + + + +{/*> **captchaImage**: `string` \| `null`*/} + +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 [`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#captchaimage) + + + + +{/*> **captchaProvider**: `string` \| `null`*/} + +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 [`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#captchaprovider) + + + + +{/*> **captchaSiteKey**: `string` \| `null`*/} + +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 [`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#captchasitekey) + + + + +{/*> **data**: \{ `username?`: `string`; \} \| `null`*/} + +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 [`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#data) + + + + +{/*> **isCaptchaAvailable**: `boolean`*/} + +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 [`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#iscaptchaavailable) + + + + +{/*> **links**: `Record`\<`string`, `string`\> \| `null`*/} + +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 [`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#links) + + + + +{/*> **name**: `string`*/} + +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 [`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#name) + + + + +{/*> **texts**: `Record`\<`string`, `string`\> \| `null`*/} + +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 [`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#texts) + \ 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..d6caff320 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnResetPasswordMfaEmailChallenge.mdx @@ -0,0 +1,102 @@ +--- +title: "ScreenMembersOnResetPasswordMfaEmailChallenge" +--- + +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 + + + +```ts Example +export interface ScreenMembersOnResetPasswordMfaEmailChallenge extends ScreenMembers { + data: { + email: string; + } | null; +} +``` + + +- Extends [`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers) + +## Properties + +CaptchaContext}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#captcha) + + + + +{/*> **captchaImage**: `string` \| `null`*/} + +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 [`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#captchaimage) + + + + +{/*> **captchaProvider**: `string` \| `null`*/} + +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 [`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#captchaprovider) + + + + +{/*> **captchaSiteKey**: `string` \| `null`*/} + +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 [`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#captchasitekey) + + + + +{/*> **data**: \{ `email`: `string`; \} \| `null`*/} + +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 [`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#data) + + + + +{/*> **isCaptchaAvailable**: `boolean`*/} + +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 [`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#iscaptchaavailable) + + + + +{/*> **links**: `Record`\<`string`, `string`\> \| `null`*/} + +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 [`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#links) + + + + +{/*> **name**: `string`*/} + +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 [`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#name) + + + + +{/*> **texts**: `Record`\<`string`, `string`\> \| `null`*/} + +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 [`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#texts) + \ 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..0d8c80c49 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnResetPasswordMfaPhoneChallenge.mdx @@ -0,0 +1,119 @@ +--- +title: "ScreenMembersOnResetPasswordMfaPhoneChallenge" +--- + +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 + + + +```ts Example +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; +} +``` + + +- Extends [`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers) + +## Properties + +CaptchaContext}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#captcha) + + + + +{/*> **captchaImage**: `string` \| `null`*/} + +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 [`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#captchaimage) + + + + +{/*> **captchaProvider**: `string` \| `null`*/} + +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 [`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#captchaprovider) + + + + +{/*> **captchaSiteKey**: `string` \| `null`*/} + +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 [`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#captchasitekey) + + + + +{/*> **data**: \{ `phoneNumber`: `string`; \} \| `null`*/} + +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 + +\{ `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#data) + + + + +{/*> **isCaptchaAvailable**: `boolean`*/} + +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 [`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#iscaptchaavailable) + + + + +{/*> **links**: `Record`\<`string`, `string`\> \| `null`*/} + +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 [`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#links) + + + + +{/*> **name**: `string`*/} + +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 [`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#name) + + + + +{/*> **texts**: `Record`\<`string`, `string`\> \| `null`*/} + +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 [`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#texts) + \ 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..566a14124 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnResetPasswordMfaPushChallengePush.mdx @@ -0,0 +1,98 @@ +--- +title: "ScreenMembersOnResetPasswordMfaPushChallengePush" +--- + +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 + + + +```ts Example +export interface ScreenMembersOnResetPasswordMfaPushChallengePush +``` + + +- Extends [`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers) + +## Properties + +CaptchaContext}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#captcha) + + + + +{/*> **captchaImage**: `string` \| `null`*/} + +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 [`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#captchaimage) + + + + +{/*> **captchaProvider**: `string` \| `null`*/} + +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 [`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#captchaprovider) + + + + +{/*> **captchaSiteKey**: `string` \| `null`*/} + +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 [`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#captchasitekey) + + + + +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#data) + + + + +{/*> **isCaptchaAvailable**: `boolean`*/} + +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 [`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#iscaptchaavailable) + + + + +{/*> **links**: `Record`\<`string`, `string`\> \| `null`*/} + +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 [`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#links) + + + + +{/*> **name**: `string`*/} + +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 [`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#name) + + + + +{/*> **texts**: `Record`\<`string`, `string`\> \| `null`*/} + +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 [`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#texts) + \ 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..753aeb621 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnResetPasswordMfaSmsChallenge.mdx @@ -0,0 +1,120 @@ +--- +title: "ScreenMembersOnResetPasswordMfaSmsChallenge" +--- + +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) + + + +```ts Example +export interface ScreenMembersOnResetPasswordMfaSmsChallenge extends ScreenMembers { + data: { + phoneNumber: string; + /** + * Whether to show the link to switch to voice call verification + */ + showLinkVoice?: boolean; + } | null; +} +``` + + +- Extends [`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers) + +## Properties + +CaptchaContext}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#captcha) + + + + +{/*> **captchaImage**: `string` \| `null`*/} + +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 [`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#captchaimage) + + + + +{/*> **captchaProvider**: `string` \| `null`*/} + +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 [`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#captchaprovider) + + + + +{/*> **captchaSiteKey**: `string` \| `null`*/} + +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 [`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#captchasitekey) + + + + +{/*> **data**: \{ `phoneNumber`: `string`; `showLinkVoice?`: `boolean`; \} \| `null`*/} + +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 + +\{ `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#data) + + + + +{/*> **isCaptchaAvailable**: `boolean`*/} + +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 [`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#iscaptchaavailable) + + + + +{/*> **links**: `Record`\<`string`, `string`\> \| `null`*/} + +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 [`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#links) + + + + +{/*> **name**: `string`*/} + +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 [`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#name) + + + + +{/*> **texts**: `Record`\<`string`, `string`\> \| `null`*/} + +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 [`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#texts) + \ 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..6fd405e81 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnResetPasswordMfaVoiceChallenge.mdx @@ -0,0 +1,128 @@ +--- +title: "ScreenMembersOnResetPasswordMfaVoiceChallenge" +--- + +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. + + + +```ts Example +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; +} +``` + + +- Extends [`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers) + +## Properties + +CaptchaContext}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#captcha) + + + + +{/*> **captchaImage**: `string` \| `null`*/} + +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 [`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#captchaimage) + + + + +{/*> **captchaProvider**: `string` \| `null`*/} + +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 [`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#captchaprovider) + + + + +{/*> **captchaSiteKey**: `string` \| `null`*/} + +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 [`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#captchasitekey) + + + + +{/*> **data**: \{ `phoneNumber`: `string`; `showLinkSms?`: `boolean`; \} \| `null`*/} + +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 + +\{ `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#data) + + + + +{/*> **isCaptchaAvailable**: `boolean`*/} + +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 [`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#iscaptchaavailable) + + + + +{/*> **links**: `Record`\<`string`, `string`\> \| `null`*/} + +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 [`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#links) + + + + +{/*> **name**: `string`*/} + +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 [`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#name) + + + + +{/*> **texts**: `Record`\<`string`, `string`\> \| `null`*/} + +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 [`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#texts) + \ 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..93df2059f --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnResetPasswordMfaWebAuthnPlatformChallenge.mdx @@ -0,0 +1,137 @@ +--- +title: "ScreenMembersOnResetPasswordMfaWebAuthnPlatformChallenge" +--- + +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 + + + +```ts Example +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; +} +``` + + +- Extends [`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers) + +## Properties + +CaptchaContext}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#captcha) + + + + +{/*> **captchaImage**: `string` \| `null`*/} + +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 [`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#captchaimage) + + + + +{/*> **captchaProvider**: `string` \| `null`*/} + +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 [`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#captchaprovider) + + + + +{/*> **captchaSiteKey**: `string` \| `null`*/} + +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 [`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#captchasitekey) + + + +PasskeyCreate}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#data) + + + + +{/*> **isCaptchaAvailable**: `boolean`*/} + +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 [`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#iscaptchaavailable) + + + + +{/*> **links**: `Record`\<`string`, `string`\> \| `null`*/} + +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 [`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#links) + + + + +{/*> **name**: `string`*/} + +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 [`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#name) + + + +AllowCredential}> +{/*> **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/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 + WebAuthn `navigator.credentials.get()` API call. + + + + +{/*> **showRememberDevice**: `boolean`*/} + +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. + Defaults to `false` if not present in the context. + + + + +{/*> **texts**: `Record`\<`string`, `string`\> \| `null`*/} + +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 [`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#texts) + \ 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..070c4edf5 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnResetPasswordMfaWebAuthnRoamingChallenge.mdx @@ -0,0 +1,140 @@ +--- +title: "ScreenMembersOnResetPasswordMfaWebAuthnRoamingChallenge" +--- + +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 + + + +```ts Example +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; +} +``` + + +- Extends [`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers) + +## Properties + +CaptchaContext}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#captcha) + + + + +{/*> **captchaImage**: `string` \| `null`*/} + +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 [`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#captchaimage) + + + + +{/*> **captchaProvider**: `string` \| `null`*/} + +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 [`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#captchaprovider) + + + + +{/*> **captchaSiteKey**: `string` \| `null`*/} + +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 [`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#captchasitekey) + + + +PasskeyCreate}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#data) + + + + +{/*> **isCaptchaAvailable**: `boolean`*/} + +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 [`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#iscaptchaavailable) + + + + +{/*> **links**: `Record`\<`string`, `string`\> \| `null`*/} + +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 [`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#links) + + + + +{/*> **name**: `string`*/} + +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 [`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#name) + + + +AllowCredential}> +{/*> **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/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()`. + + + + +{/*> **showRememberDevice**: `boolean`*/} + +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. + + + + +{/*> **texts**: `Record`\<`string`, `string`\> \| `null`*/} + +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 [`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#texts) + \ 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..b7d2472f0 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnResetPasswordRequest.mdx @@ -0,0 +1,102 @@ +--- +title: "ScreenMembersOnResetPasswordRequest" +--- + +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) + + + +```ts Example +export interface ScreenMembersOnResetPasswordRequest extends ScreenMembers { + data: { + phone?: string; + email?: string; + username?: string; + } | null; +} +``` + + +- Extends [`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers) + +## Properties + +CaptchaContext}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#captcha) + + + + +{/*> **captchaImage**: `string` \| `null`*/} + +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 [`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#captchaimage) + + + + +{/*> **captchaProvider**: `string` \| `null`*/} + +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 [`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#captchaprovider) + + + + +{/*> **captchaSiteKey**: `string` \| `null`*/} + +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 [`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#captchasitekey) + + + + +{/*> **data**: \{ `email?`: `string`; `phone?`: `string`; `username?`: `string`; \} \| `null`*/} + +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 [`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#data) + + + + +{/*> **isCaptchaAvailable**: `boolean`*/} + +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 [`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#iscaptchaavailable) + + + + +{/*> **links**: `Record`\<`string`, `string`\> \| `null`*/} + +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 [`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#links) + + + + +{/*> **name**: `string`*/} + +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 [`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#name) + + + + +{/*> **texts**: `Record`\<`string`, `string`\> \| `null`*/} + +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 [`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#texts) + \ 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..5e6dffb0b --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnResetPasswordSuccess.mdx @@ -0,0 +1,96 @@ +--- +title: "ScreenMembersOnResetPasswordSuccess" +--- + +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) + + + +```ts Example +export interface ScreenMembersOnResetPasswordSuccess extends ScreenMembers {} +``` + + +- Extends [`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers) + +## Properties + +CaptchaContext}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#captcha) + + + + +{/*> **captchaImage**: `string` \| `null`*/} + +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 [`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#captchaimage) + + + + +{/*> **captchaProvider**: `string` \| `null`*/} + +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 [`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#captchaprovider) + + + + +{/*> **captchaSiteKey**: `string` \| `null`*/} + +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 [`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#captchasitekey) + + + +PasskeyCreate}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#data) + + + + +{/*> **isCaptchaAvailable**: `boolean`*/} + +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 [`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#iscaptchaavailable) + + + + +{/*> **links**: `Record`\<`string`, `string`\> \| `null`*/} + +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 [`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#links) + + + + +{/*> **name**: `string`*/} + +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 [`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#name) + + + + +{/*> **texts**: `Record`\<`string`, `string`\> \| `null`*/} + +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 [`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#texts) + \ 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..2c0f712e7 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnSignup.mdx @@ -0,0 +1,105 @@ +--- +title: "ScreenMembersOnSignup" +--- + +Defined in: [interfaces/screens/signup.ts:23](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/signup.ts#L23) + + + +```ts Example +export interface ScreenMembersOnSignup extends ScreenMembers { + loginLink: string | null; +} +``` + + +- Extends [`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers) + +## Properties + +CaptchaContext}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#captcha) + + + + +{/*> **captchaImage**: `string` \| `null`*/} + +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 [`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#captchaimage) + + + + +{/*> **captchaProvider**: `string` \| `null`*/} + +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 [`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#captchaprovider) + + + + +{/*> **captchaSiteKey**: `string` \| `null`*/} + +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 [`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#captchasitekey) + + + +PasskeyCreate}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#data) + + + + +{/*> **isCaptchaAvailable**: `boolean`*/} + +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 [`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#iscaptchaavailable) + + + + +{/*> **links**: `Record`\<`string`, `string`\> \| `null`*/} + +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 [`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#links) + + + + +{/*> **loginLink**: `string` \| `null`*/} + +Defined in: [interfaces/screens/signup.ts:24](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/signup.ts#L24) + + + + +{/*> **name**: `string`*/} + +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 [`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#name) + + + + +{/*> **texts**: `Record`\<`string`, `string`\> \| `null`*/} + +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 [`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#texts) + \ 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..da8e8ef04 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnSignupId.mdx @@ -0,0 +1,105 @@ +--- +title: "ScreenMembersOnSignupId" +--- + +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) + + + +```ts Example +export interface ScreenMembersOnSignupId extends ScreenMembers { + loginLink: string | null; +} +``` + + +- Extends [`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers) + +## Properties + +CaptchaContext}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#captcha) + + + + +{/*> **captchaImage**: `string` \| `null`*/} + +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 [`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#captchaimage) + + + + +{/*> **captchaProvider**: `string` \| `null`*/} + +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 [`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#captchaprovider) + + + + +{/*> **captchaSiteKey**: `string` \| `null`*/} + +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 [`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#captchasitekey) + + + +PasskeyCreate}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#data) + + + + +{/*> **isCaptchaAvailable**: `boolean`*/} + +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 [`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#iscaptchaavailable) + + + + +{/*> **links**: `Record`\<`string`, `string`\> \| `null`*/} + +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 [`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#links) + + + + +{/*> **loginLink**: `string` \| `null`*/} + +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) + + + + +{/*> **name**: `string`*/} + +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 [`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#name) + + + + +{/*> **texts**: `Record`\<`string`, `string`\> \| `null`*/} + +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 [`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#texts) + \ 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..245829be9 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnSignupPassword.mdx @@ -0,0 +1,118 @@ +--- +title: "ScreenMembersOnSignupPassword" +--- + +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) + + + +```ts Example +export interface ScreenMembersOnSignupPassword extends ScreenMembers { + loginLink: string | null; + editLink: string | null; + data: { + email?: string; + phoneNumber?: string; + username?: string; + } | null; +} +``` + + +- Extends [`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers) + +## Properties + +CaptchaContext}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#captcha) + + + + +{/*> **captchaImage**: `string` \| `null`*/} + +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 [`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#captchaimage) + + + + +{/*> **captchaProvider**: `string` \| `null`*/} + +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 [`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#captchaprovider) + + + + +{/*> **captchaSiteKey**: `string` \| `null`*/} + +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 [`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#captchasitekey) + + + + +{/*> **data**: \{ `email?`: `string`; `phoneNumber?`: `string`; `username?`: `string`; \} \| `null`*/} + +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 [`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#data) + + + + +{/*> **editLink**: `string` \| `null`*/} + +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) + + + + +{/*> **isCaptchaAvailable**: `boolean`*/} + +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 [`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#iscaptchaavailable) + + + + +{/*> **links**: `Record`\<`string`, `string`\> \| `null`*/} + +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 [`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#links) + + + + +{/*> **loginLink**: `string` \| `null`*/} + +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) + + + + +{/*> **name**: `string`*/} + +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 [`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#name) + + + + +{/*> **texts**: `Record`\<`string`, `string`\> \| `null`*/} + +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 [`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#texts) + \ 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..61593b9f1 --- /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/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/mfa-country-codes.ts#L18) + +Options for selecting a country code + + + +```ts Example +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; +} +``` + + +## 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/5c054686de6099ea69493d68134be65604477bb6/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/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 new file mode 100644 index 000000000..3a1ad0491 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/SelectMfaEmailOptions.mdx @@ -0,0 +1,38 @@ +--- +title: "SelectMfaEmailOptions" +--- + +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 + + + +```ts Example +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; +} +``` + + +## Indexable + +\[`key`: `string`\]: `string` \| `number` \| `boolean` \| `undefined` + +Any additional custom options + +## Properties + + +{/*> **index**: `number`*/} + +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) + +The index of the phone number to select. + \ 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..bed3685f0 --- /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/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/mfa-push-list.ts#L7) + +Options for selecting an MFA push device. + + + +```ts Example +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; +} +``` + + +## Indexable + +\[`key`: `string`\]: `string` \| `number` \| `boolean` \| `undefined` + +## Properties + + +{/*> **deviceIndex**: `number`*/} + +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. + \ 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..43ace2e94 --- /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/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/organization-picker.ts#L4) + + + +```ts Example +export interface SelectOrganizationOptions { + organization: string; + state: string; +} +``` + + +## Properties + + +{/*> **organization**: `string`*/} + +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) + + + + +{/*> **state**: `string`*/} + +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) + \ 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..e3a90c979 --- /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/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/mfa-webauthn-roaming-enrollment.ts#L14) + +Options for submitting a WebAuthn browser error. + + + +```ts Example +export interface ShowErrorOptions { + /** + * The details of the WebAuthn error. + */ + error: WebAuthnErrorDetails; + /** + * Any additional custom options. + */ + [key: string]: string | number | boolean | undefined | WebAuthnErrorDetails; +} +``` + + +## 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 + +WebAuthnErrorDetails}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/mfa-webauthn-roaming-enrollment.ts#L18) + +The details of the WebAuthn error. + \ 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..7e19a9564 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/SignupIdMembers.mdx @@ -0,0 +1,174 @@ +--- +title: "SignupIdMembers" +--- + +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) + + + +```ts Example +export interface SignupIdMembers extends BaseMembers { + screen: ScreenMembersOnSignupId; + transaction: TransactionMembersOnSignupId; + signup(payload: SignupOptions): Promise; + federatedSignup(payload: FederatedSignupOptions): Promise; + getSignupIdentifiers(): Identifier[] | null; + pickCountryCode(payload?: CustomOptions): Promise; + validateUsername(username: string): UsernameValidationResult; +} +``` + + +- Extends [`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers) + +## Properties + +BrandingMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#branding) + + + +ClientMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#client) + + + +OrganizationMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#organization) + + + +PromptMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#prompt) + + + +ScreenMembersOnSignupId}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#screen) + + + +TenantMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#tenant) + + + +TransactionMembersOnSignupId}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#transaction) + + + +UntrustedDataMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#untrusteddata) + + + +UserMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#user) + + +## Methods + + +{/*> **federatedSignup**(`payload`): `Promise`\<`void`\>*/} + +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) + + +FederatedSignupOptions}> +[`FederatedSignupOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/FederatedSignupOptions) + + + +- Returns `Promise`\<`void`\> + + + +Identifier[]}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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` + + + + +{/*> **pickCountryCode**(`payload?`): `Promise`\<`void`\>*/} + +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) + + +CustomOptions}> +[`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CustomOptions) + + + +- Returns `Promise`\<`void`\> + + + + +{/*> **signup**(`payload`): `Promise`\<`void`\>*/} + +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) + + +SignupOptions}> +[`SignupOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/SignupOptions) + + + +- Returns `Promise`\<`void`\> + + + +UsernameValidationResult}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/signup-id.ts#L61) + + + +`string` + + + +- Returns [`UsernameValidationResult`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UsernameValidationResult) + \ 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..434891516 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/SignupMembers.mdx @@ -0,0 +1,234 @@ +--- +title: "SignupMembers" +--- + +Defined in: [interfaces/screens/signup.ts:35](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/signup.ts#L35) + + + +```ts Example +export interface SignupMembers extends BaseMembers { + screen: ScreenMembersOnSignup; + transaction: TransactionMembersOnSignup; + signup(payload: SignupOptions): Promise; + federatedSignup(payload: FederatedSignupOptions): Promise; + pickCountryCode(payload?: CustomOptions): Promise; + 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; +} +``` + + +- Extends [`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers) + +## Properties + +BrandingMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#branding) + + + +ClientMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#client) + + + +OrganizationMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#organization) + + + +PromptMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#prompt) + + + +ScreenMembersOnSignup}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#screen) + + + +TenantMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#tenant) + + + +TransactionMembersOnSignup}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#transaction) + + + +UntrustedDataMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#untrusteddata) + + + +UserMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#user) + + +## Methods + + +{/*> **federatedSignup**(`payload`): `Promise`\<`void`\>*/} + +Defined in: [interfaces/screens/signup.ts:39](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/signup.ts#L39) + + +FederatedSignupPayloadOptions}> +[`FederatedSignupPayloadOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/FederatedSignupPayloadOptions) + + + +- Returns `Promise`\<`void`\> + + + +Identifier[]}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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. + +```ts Example +const identifiers = authClient.getSignupIdentifiers(); +if (identifiers) { + identifiers.forEach(({ type, required }) => { + console.log(`${type} is ${required ? 'required' : 'optional'}`); + }); +} +``` + +#### See + +Identifier + + + + +{/*> **pickCountryCode**(`payload?`): `Promise`\<`void`\>*/} + +Defined in: [interfaces/screens/signup.ts:40](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/signup.ts#L40) + + +CustomOptions}> +[`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CustomOptions) + + + +- Returns `Promise`\<`void`\> + + + + +{/*> **signup**(`payload`): `Promise`\<`void`\>*/} + +Defined in: [interfaces/screens/signup.ts:38](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/signup.ts#L38) + + +SignupPayloadOptions}> +[`SignupPayloadOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/SignupPayloadOptions) + + + +- Returns `Promise`\<`void`\> + + + +PasswordValidationResult}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/signup.ts#L41) + + + +`string` + + + +- Returns [`PasswordValidationResult`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PasswordValidationResult) + + + +UsernameValidationResult}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/signup.ts#L64) + + + +`string` + + + +- Returns [`UsernameValidationResult`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UsernameValidationResult) + \ 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..1d1004c12 --- /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/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/signup-id.ts#L46) + + + +```ts Example +export interface SignupOptions { + email?: string; + username?: string; + phone?: string; + captcha?: string; + [key: string]: string | number | boolean | undefined; +} +``` + + +## Indexable + +\[`key`: `string`\]: `string` \| `number` \| `boolean` \| `undefined` + +## Properties + + +{/*> `optional` **captcha**: `string`*/} + +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) + + + + +{/*> `optional` **email**: `string`*/} + +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) + + + + +{/*> `optional` **phone**: `string`*/} + +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) + + + + +{/*> `optional` **username**: `string`*/} + +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) + \ 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..b94dec223 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/SignupPasswordMembers.mdx @@ -0,0 +1,148 @@ +--- +title: "SignupPasswordMembers" +--- + +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) + + + +```ts Example +export interface SignupPasswordMembers extends BaseMembers { + screen: ScreenMembersOnSignupPassword; + transaction: TransactionMembersOnSignupPassword; + signup(payload: SignupPasswordOptions): Promise; + federatedSignup(payload: FederatedSignupOptions): Promise; + validatePassword(password: string): PasswordValidationResult; +} +``` + + +- Extends [`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers) + +## Properties + +BrandingMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#branding) + + + +ClientMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#client) + + + +OrganizationMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#organization) + + + +PromptMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#prompt) + + + +ScreenMembersOnSignupPassword}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#screen) + + + +TenantMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#tenant) + + + +TransactionMembersOnSignupPassword}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#transaction) + + + +UntrustedDataMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#untrusteddata) + + + +UserMembers}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#user) + + +## Methods + + +{/*> **federatedSignup**(`payload`): `Promise`\<`void`\>*/} + +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) + + +FederatedSignupPasswordPayloadOptions}> +[`FederatedSignupPasswordPayloadOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/FederatedSignupPasswordPayloadOptions) + + + +- Returns `Promise`\<`void`\> + + + + +{/*> **signup**(`payload`): `Promise`\<`void`\>*/} + +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) + + +SignupPasswordOptions}> +[`SignupPasswordOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/SignupPasswordOptions) + + + +- Returns `Promise`\<`void`\> + + + +PasswordValidationResult}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/signup-password.ts#L60) + + + +`string` + + + +- Returns [`PasswordValidationResult`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PasswordValidationResult) + \ 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..27f300b07 --- /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/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/signup-password.ts#L46) + + + +```ts Example +export interface SignupPasswordOptions { + email?: string; + username?: string; + phoneNumber?: string; + password: string; + captcha?: string; + [key: string]: string | number | boolean | undefined; +} +``` + + +## Indexable + +\[`key`: `string`\]: `string` \| `number` \| `boolean` \| `undefined` + +## Properties + + +{/*> `optional` **captcha**: `string`*/} + +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) + + + + +{/*> `optional` **email**: `string`*/} + +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) + + + + +{/*> **password**: `string`*/} + +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) + + + + +{/*> `optional` **phoneNumber**: `string`*/} + +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) + + + + +{/*> `optional` **username**: `string`*/} + +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) + \ 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..51a681b01 --- /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/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/signup.ts#L9) + + + +```ts Example +export interface SignupOptions { + email?: string; + username?: string; + phoneNumber?: string; + password?: string; + captcha?: string; + [key: string]: string | number | boolean | undefined; +} +``` + + +## Indexable + +\[`key`: `string`\]: `string` \| `number` \| `boolean` \| `undefined` + +## Properties + + +{/*> `optional` **captcha**: `string`*/} + +Defined in: [interfaces/screens/signup.ts:14](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/signup.ts#L14) + + + + +{/*> `optional` **email**: `string`*/} + +Defined in: [interfaces/screens/signup.ts:10](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/signup.ts#L10) + + + + +{/*> `optional` **password**: `string`*/} + +Defined in: [interfaces/screens/signup.ts:13](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/signup.ts#L13) + + + + +{/*> `optional` **phoneNumber**: `string`*/} + +Defined in: [interfaces/screens/signup.ts:12](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/signup.ts#L12) + + + + +{/*> `optional` **username**: `string`*/} + +Defined in: [interfaces/screens/signup.ts:11](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/signup.ts#L11) + \ 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..9e89f29b9 --- /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/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/utils/resend-control.ts#L11) + +Options for configuring resend functionality + + + +```ts Example +export interface StartResendOptions { + timeoutSeconds?: number; + onStatusChange?: OnStatusChangeCallback; + onTimeout?: () => void; +} +``` + + +## Properties + +OnStatusChangeCallback}> +{/*> `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/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/utils/resend-control.ts#L13) + + + +{/*> `optional` **onTimeout**: () => `void`*/} + +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` + + + + + +{/*> `optional` **timeoutSeconds**: `number`*/} + +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) + \ 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..29386f079 --- /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/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/interstitial-captcha.ts#L3) + + + +```ts Example +export interface SubmitCaptchaOptions { + captcha: string; + [key: string]: string | number; +} +``` + + +## Indexable + +\[`key`: `string`\]: `string` \| `number` + +## Properties + + +{/*> **captcha**: `string`*/} + +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) + \ 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..c1f6d4348 --- /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/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/login-passwordless-email-code.ts#L21) + + + +```ts Example +export interface SubmitCodeOptions { + code: string | number; + captcha?: string; + [key: string]: string | number | boolean | undefined; +} +``` + + +## Indexable + +\[`key`: `string`\]: `string` \| `number` \| `boolean` \| `undefined` + +## Properties + + +{/*> `optional` **captcha**: `string`*/} + +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) + + + + +{/*> **code**: `string` \| `number`*/} + +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) + \ 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..a02d1e3d9 --- /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/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/login-passwordless-sms-otp.ts#L28) + + + +```ts Example +export interface SubmitOTPOptions { + username?: string; + code: string; + captcha?: string; + [key: string]: string | number | boolean | undefined; +} +``` + + +## Indexable + +\[`key`: `string`\]: `string` \| `number` \| `boolean` \| `undefined` + +## Properties + + +{/*> `optional` **captcha**: `string`*/} + +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) + + + + +{/*> **code**: `string`*/} + +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) + + + + +{/*> `optional` **username**: `string`*/} + +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) + \ 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..b021ddfe8 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/SubmitPasskeyCredentialOptions.mdx @@ -0,0 +1,22 @@ +--- +title: "SubmitPasskeyCredentialOptions" +--- + +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 + + + +```ts Example +export interface SubmitPasskeyCredentialOptions extends CustomOptions { + // No longer requires publicKey here, as it's sourced from this.screen.publicKey +} +``` + + +- 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..49173063c --- /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/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/tenant.ts#L8) + + + +```ts Example +export interface TenantMembers { + name: string | null; + friendlyName: string | null; + enabledLocales: string[] | null; + enabledFactors: string[] | null; +} +``` + + +## Properties + + +{/*> **enabledFactors**: `string`[] \| `null`*/} + +Defined in: [interfaces/models/tenant.ts:12](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/tenant.ts#L12) + + + + +{/*> **enabledLocales**: `string`[] \| `null`*/} + +Defined in: [interfaces/models/tenant.ts:11](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/tenant.ts#L11) + + + + +{/*> **friendlyName**: `string` \| `null`*/} + +Defined in: [interfaces/models/tenant.ts:10](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/tenant.ts#L10) + + + + +{/*> **name**: `string` \| `null`*/} + +Defined in: [interfaces/models/tenant.ts:9](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/tenant.ts#L9) + \ 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..3266fc589 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers.mdx @@ -0,0 +1,248 @@ +--- +title: "TransactionMembers" +--- + +Defined in: [interfaces/models/transaction.ts:165](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/transaction.ts#L165) + + + +```ts Example +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; +} +``` + + +## 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 + +[Connection] | [EnterpriseConnection][]}> +{/*> **alternateConnections**: ([`Connection`](#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/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/transaction.ts#L174) + + + + +{/*> **connectionStrategy**: `string` \| `null`*/} + +Defined in: [interfaces/models/transaction.ts:170](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/transaction.ts#L170) + + + + +{/*> **countryCode**: `string` \| `null`*/} + +Defined in: [interfaces/models/transaction.ts:168](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/transaction.ts#L168) + + + + +{/*> **countryPrefix**: `string` \| `null`*/} + +Defined in: [interfaces/models/transaction.ts:169](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/transaction.ts#L169) + + + +[Connection]}> +{/*> **currentConnection**: [`Connection`](#connection) \| `null`*/} + +Defined in: [interfaces/models/transaction.ts:173](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/transaction.ts#L173) + + + +[Error]}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/transaction.ts#L172) + + + + +{/*> **hasErrors**: `boolean`*/} + +Defined in: [interfaces/models/transaction.ts:171](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/transaction.ts#L171) + + + + +{/*> **locale**: `string`*/} + +Defined in: [interfaces/models/transaction.ts:167](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/transaction.ts#L167) + + + + +{/*> **state**: `string`*/} + +Defined in: [interfaces/models/transaction.ts:166](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/transaction.ts#L166) + + +## Connection + +Defined in: [interfaces/models/transaction.ts:1](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/transaction.ts#L1) + + +```ts +export interface Connection { + name: string; + strategy: string; + metadata?: Record; +} +``` + +### Extended by + +- [`EnterpriseConnection`](#EnterpriseConnection) + +### Properties + + +{/*> `optional` **metadata**: `Record`\<`string`, `string`\>*/} + +Defined in: [interfaces/models/transaction.ts:4](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/transaction.ts#L4) + + + + +{/*> **name**: `string`*/} + +Defined in: [interfaces/models/transaction.ts:2](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/transaction.ts#L2) + + + + +{/*> **strategy**: `string`*/} + +Defined in: [interfaces/models/transaction.ts:3](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/transaction.ts#L3) + + +## EnterpriseConnection + +Defined in: [interfaces/models/transaction.ts:126](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/transaction.ts#L126) + + +```ts +export interface EnterpriseConnection extends Connection { + options: { + iconUrl?: string; + displayName?: string; + showAsButton: boolean; + }; +} +``` + +- Extends [`Connection`](#connection) + +### Properties + + +{/*> `optional` **metadata**: `Record`\<`string`, `string`\>*/} + +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 [`Connection`](#connection).[`metadata`](#connection#metadata) + + + + +{/*> **name**: `string`*/} + +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 [`Connection`](#connection).[`name`](#connection#name) + + + + +{/*> **options**: `object`*/} + +Defined in: [interfaces/models/transaction.ts:127](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/transaction.ts#L127) + + + + + +{/*> `optional` **displayName**: `string`*/} + + + +{/*> `optional` **iconUrl**: `string`*/} + + + +{/*> **showAsButton**: `boolean`*/} + + + + + +{/*> **strategy**: `string`*/} + +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 [`Connection`](#connection).[`strategy`](#connection#strategy) + + +## PasswordPolicy + +Defined in: [interfaces/models/transaction.ts:57](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/transaction.ts#L57) + + +```ts +export interface PasswordPolicy { + enabled?: boolean; + minLength?: number; + policy: 'none' | 'low' | 'fair' | 'good' | 'excellent'; + passwordSecurityInfo?: PasswordComplexityRule[]; +} +``` + +### Properties + + +{/*> `optional` **enabled**: `boolean`*/} + +Defined in: [interfaces/models/transaction.ts:58](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/transaction.ts#L58) + + + + +{/*> `optional` **minLength**: `number`*/} + +Defined in: [interfaces/models/transaction.ts:59](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/transaction.ts#L59) + + + +[PasswordComplexityRule][]}> +{/*> `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/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/transaction.ts#L61) + + + + +{/*> **policy**: `"none"` \| `"low"` \| `"fair"` \| `"good"` \| `"excellent"`*/} + +Defined in: [interfaces/models/transaction.ts:60](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/transaction.ts#L60) + \ 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..7010b7edb --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembersOnLogin.mdx @@ -0,0 +1,139 @@ +--- +title: "TransactionMembersOnLogin" +--- + +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 + + + +```ts Example +export interface TransactionMembersOnLogin extends TransactionMembers { + isSignupEnabled: boolean; + isForgotPasswordEnabled: boolean; + isPasskeyEnabled: boolean; + passwordPolicy: PasswordPolicy | null; + allowedIdentifiers: IdentifierType[] | null; +} +``` + + +- Extends [`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers) + +## Properties + +IdentifierType}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/login.ts#L42) + + + +Connection}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#alternateconnections) + + + + +{/*> **connectionStrategy**: `string` \| `null`*/} + +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 [`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#connectionstrategy) + + + + +{/*> **countryCode**: `string` \| `null`*/} + +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 [`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#countrycode) + + + + +{/*> **countryPrefix**: `string` \| `null`*/} + +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 [`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#countryprefix) + + + +Connection}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#currentconnection) + + + +Error}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#errors) + + + + +{/*> **hasErrors**: `boolean`*/} + +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 [`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#haserrors) + + + + +{/*> **isForgotPasswordEnabled**: `boolean`*/} + +Defined in: [interfaces/screens/login.ts:39](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/login.ts#L39) + + + + +{/*> **isPasskeyEnabled**: `boolean`*/} + +Defined in: [interfaces/screens/login.ts:40](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/login.ts#L40) + + + + +{/*> **isSignupEnabled**: `boolean`*/} + +Defined in: [interfaces/screens/login.ts:38](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/login.ts#L38) + + + + +{/*> **locale**: `string`*/} + +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 [`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#locale) + + + +PasswordPolicy}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/login.ts#L41) + + + + +{/*> **state**: `string`*/} + +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 [`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#state) + \ 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..20ccd108a --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembersOnLoginId.mdx @@ -0,0 +1,145 @@ +--- +title: "TransactionMembersOnLoginId" +--- + +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) + + + +```ts Example +export interface TransactionMembersOnLoginId extends TransactionMembers { + isSignupEnabled: boolean; + isPasskeyEnabled: boolean; + isForgotPasswordEnabled: boolean; + isUsernameRequired: boolean; + usernamePolicy: UsernamePolicy | null; + allowedIdentifiers: IdentifierType[] | null; +} +``` + + +- Extends [`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers) + +## Properties + +IdentifierType}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/login-id.ts#L43) + + + +Connection}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#alternateconnections) + + + + +{/*> **connectionStrategy**: `string` \| `null`*/} + +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 [`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#connectionstrategy) + + + + +{/*> **countryCode**: `string` \| `null`*/} + +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 [`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#countrycode) + + + + +{/*> **countryPrefix**: `string` \| `null`*/} + +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 [`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#countryprefix) + + + +Connection}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#currentconnection) + + + +Error}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#errors) + + + + +{/*> **hasErrors**: `boolean`*/} + +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 [`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#haserrors) + + + + +{/*> **isForgotPasswordEnabled**: `boolean`*/} + +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) + + + + +{/*> **isPasskeyEnabled**: `boolean`*/} + +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) + + + + +{/*> **isSignupEnabled**: `boolean`*/} + +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) + + + + +{/*> **isUsernameRequired**: `boolean`*/} + +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) + + + + +{/*> **locale**: `string`*/} + +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 [`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#locale) + + + + +{/*> **state**: `string`*/} + +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 [`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#state) + + + +UsernamePolicy}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/login-id.ts#L42) + \ 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..7607f0b9b --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembersOnLoginPassword.mdx @@ -0,0 +1,152 @@ +--- +title: "TransactionMembersOnLoginPassword" +--- + +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) + + + +```ts Example +export interface TransactionMembersOnLoginPassword extends TransactionMembers { + isSignupEnabled: boolean; + isForgotPasswordEnabled: boolean; + isPasskeyEnabled: boolean; + getPasswordPolicy(): PasswordPolicy | null; + getUsernamePolicy(): UsernamePolicy | null; + getAllowedIdentifiers(): IdentifierType[] | null; +} +``` + + +- Extends [`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers) + +## Properties + +Connection}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#alternateconnections) + + + + +{/*> **connectionStrategy**: `string` \| `null`*/} + +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 [`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#connectionstrategy) + + + + +{/*> **countryCode**: `string` \| `null`*/} + +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 [`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#countrycode) + + + + +{/*> **countryPrefix**: `string` \| `null`*/} + +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 [`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#countryprefix) + + + +Connection}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#currentconnection) + + + +Error}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#errors) + + + + +{/*> **hasErrors**: `boolean`*/} + +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 [`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#haserrors) + + + + +{/*> **isForgotPasswordEnabled**: `boolean`*/} + +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) + + + + +{/*> **isPasskeyEnabled**: `boolean`*/} + +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) + + + + +{/*> **isSignupEnabled**: `boolean`*/} + +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) + + + + +{/*> **locale**: `string`*/} + +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 [`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#locale) + + + + +{/*> **state**: `string`*/} + +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 [`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#state) + + +## Methods + +IdentifierType[]}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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` + + + +PasswordPolicy}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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` + + + +UsernamePolicy}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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` + \ 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..c4d2f09ac --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembersOnLoginPasswordlessEmailCode.mdx @@ -0,0 +1,105 @@ +--- +title: "TransactionMembersOnLoginPasswordlessEmailCode" +--- + +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) + + + +```ts Example +export interface TransactionMembersOnLoginPasswordlessEmailCode extends TransactionMembers { + isSignupEnabled: boolean | null; +} +``` + + +- Extends [`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers) + +## Properties + +Connection}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#alternateconnections) + + + + +{/*> **connectionStrategy**: `string` \| `null`*/} + +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 [`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#connectionstrategy) + + + + +{/*> **countryCode**: `string` \| `null`*/} + +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 [`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#countrycode) + + + + +{/*> **countryPrefix**: `string` \| `null`*/} + +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 [`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#countryprefix) + + + +Connection}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#currentconnection) + + + +Error}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#errors) + + + + +{/*> **hasErrors**: `boolean`*/} + +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 [`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#haserrors) + + + + +{/*> **isSignupEnabled**: `boolean` \| `null`*/} + +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) + + + + +{/*> **locale**: `string`*/} + +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 [`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#locale) + + + + +{/*> **state**: `string`*/} + +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 [`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#state) + \ 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..9f991ff8f --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembersOnLoginPasswordlessSmsOtp.mdx @@ -0,0 +1,105 @@ +--- +title: "TransactionMembersOnLoginPasswordlessSmsOtp" +--- + +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) + + + +```ts Example +export interface TransactionMembersOnLoginPasswordlessSmsOtp extends TransactionMembers { + isSignupEnabled: boolean; +} +``` + + +- Extends [`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers) + +## Properties + +Connection}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#alternateconnections) + + + + +{/*> **connectionStrategy**: `string` \| `null`*/} + +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 [`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#connectionstrategy) + + + + +{/*> **countryCode**: `string` \| `null`*/} + +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 [`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#countrycode) + + + + +{/*> **countryPrefix**: `string` \| `null`*/} + +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 [`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#countryprefix) + + + +Connection}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#currentconnection) + + + +Error}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#errors) + + + + +{/*> **hasErrors**: `boolean`*/} + +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 [`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#haserrors) + + + + +{/*> **isSignupEnabled**: `boolean`*/} + +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) + + + + +{/*> **locale**: `string`*/} + +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 [`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#locale) + + + + +{/*> **state**: `string`*/} + +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 [`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#state) + \ 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..23b302512 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembersOnResetPassword.mdx @@ -0,0 +1,105 @@ +--- +title: "TransactionMembersOnResetPassword" +--- + +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) + + + +```ts Example +export interface TransactionMembersOnResetPassword extends TransactionMembers { + passwordPolicy: PasswordPolicy | null; +} +``` + + +- Extends [`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers) + +## Properties + +Connection}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#alternateconnections) + + + + +{/*> **connectionStrategy**: `string` \| `null`*/} + +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 [`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#connectionstrategy) + + + + +{/*> **countryCode**: `string` \| `null`*/} + +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 [`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#countrycode) + + + + +{/*> **countryPrefix**: `string` \| `null`*/} + +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 [`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#countryprefix) + + + +Connection}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#currentconnection) + + + +Error}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#errors) + + + + +{/*> **hasErrors**: `boolean`*/} + +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 [`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#haserrors) + + + + +{/*> **locale**: `string`*/} + +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 [`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#locale) + + + +PasswordPolicy}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/reset-password.ts#L20) + + + + +{/*> **state**: `string`*/} + +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 [`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#state) + \ 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..1a4fe1a61 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembersOnResetPasswordRequest.mdx @@ -0,0 +1,121 @@ +--- +title: "TransactionMembersOnResetPasswordRequest" +--- + +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) + + + +```ts Example +export interface TransactionMembersOnResetPasswordRequest extends TransactionMembers { + allowedIdentifiers: IdentifierType[] | null; + requiredIdentifiers: IdentifierType[] | null; + hasFlexibleIdentifier: boolean; +} +``` + + +- Extends [`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers) + +## Properties + +IdentifierType}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/reset-password-request.ts#L14) + + + +Connection}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#alternateconnections) + + + + +{/*> **connectionStrategy**: `string` \| `null`*/} + +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 [`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#connectionstrategy) + + + + +{/*> **countryCode**: `string` \| `null`*/} + +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 [`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#countrycode) + + + + +{/*> **countryPrefix**: `string` \| `null`*/} + +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 [`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#countryprefix) + + + +Connection}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#currentconnection) + + + +Error}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#errors) + + + + +{/*> **hasErrors**: `boolean`*/} + +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 [`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#haserrors) + + + + +{/*> **hasFlexibleIdentifier**: `boolean`*/} + +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) + + + + +{/*> **locale**: `string`*/} + +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 [`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#locale) + + + +IdentifierType}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/reset-password-request.ts#L15) + + + + +{/*> **state**: `string`*/} + +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 [`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#state) + \ 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..6fdadce7f --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembersOnSignup.mdx @@ -0,0 +1,137 @@ +--- +title: "TransactionMembersOnSignup" +--- + +Defined in: [interfaces/screens/signup.ts:27](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/signup.ts#L27) + + + +```ts Example +export interface TransactionMembersOnSignup extends TransactionMembers { + isPasskeyEnabled: boolean; + usernamePolicy: UsernamePolicy | null; + requiredIdentifiers: IdentifierType[] | null; + optionalIdentifiers: IdentifierType[] | null; + passwordPolicy: PasswordPolicy | null; +} +``` + + +- Extends [`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers) + +## Properties + +Connection}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#alternateconnections) + + + + +{/*> **connectionStrategy**: `string` \| `null`*/} + +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 [`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#connectionstrategy) + + + + +{/*> **countryCode**: `string` \| `null`*/} + +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 [`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#countrycode) + + + + +{/*> **countryPrefix**: `string` \| `null`*/} + +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 [`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#countryprefix) + + + +Connection}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#currentconnection) + + + +Error}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#errors) + + + + +{/*> **hasErrors**: `boolean`*/} + +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 [`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#haserrors) + + + + +{/*> **isPasskeyEnabled**: `boolean`*/} + +Defined in: [interfaces/screens/signup.ts:28](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/signup.ts#L28) + + + + +{/*> **locale**: `string`*/} + +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 [`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#locale) + + + +IdentifierType}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/signup.ts#L31) + + + +PasswordPolicy}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/signup.ts#L32) + + + +IdentifierType}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/signup.ts#L30) + + + + +{/*> **state**: `string`*/} + +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 [`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#state) + + + +UsernamePolicy}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/signup.ts#L29) + \ 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..134f7c8fa --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembersOnSignupId.mdx @@ -0,0 +1,129 @@ +--- +title: "TransactionMembersOnSignupId" +--- + +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) + + + +```ts Example +export interface TransactionMembersOnSignupId extends TransactionMembers { + isPasskeyEnabled: boolean; + usernamePolicy: UsernamePolicy | null; + requiredIdentifiers: IdentifierType[] | null; + optionalIdentifiers: IdentifierType[] | null; +} +``` + + +- Extends [`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers) + +## Properties + +Connection}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#alternateconnections) + + + + +{/*> **connectionStrategy**: `string` \| `null`*/} + +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 [`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#connectionstrategy) + + + + +{/*> **countryCode**: `string` \| `null`*/} + +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 [`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#countrycode) + + + + +{/*> **countryPrefix**: `string` \| `null`*/} + +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 [`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#countryprefix) + + + +Connection}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#currentconnection) + + + +Error}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#errors) + + + + +{/*> **hasErrors**: `boolean`*/} + +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 [`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#haserrors) + + + + +{/*> **isPasskeyEnabled**: `boolean`*/} + +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) + + + + +{/*> **locale**: `string`*/} + +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 [`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#locale) + + + +IdentifierType}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/signup-id.ts#L33) + + + +IdentifierType}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/signup-id.ts#L32) + + + + +{/*> **state**: `string`*/} + +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 [`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#state) + + + +UsernamePolicy}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/signup-id.ts#L31) + \ 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..53889518a --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembersOnSignupPassword.mdx @@ -0,0 +1,129 @@ +--- +title: "TransactionMembersOnSignupPassword" +--- + +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) + + + +```ts Example +export interface TransactionMembersOnSignupPassword extends TransactionMembers { + isPasskeyEnabled: boolean; + passwordPolicy: PasswordPolicy | null; + requiredIdentifiers: IdentifierType[] | null; + optionalIdentifiers: IdentifierType[] | null; +} +``` + + +- Extends [`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers) + +## Properties + +Connection}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#alternateconnections) + + + + +{/*> **connectionStrategy**: `string` \| `null`*/} + +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 [`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#connectionstrategy) + + + + +{/*> **countryCode**: `string` \| `null`*/} + +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 [`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#countrycode) + + + + +{/*> **countryPrefix**: `string` \| `null`*/} + +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 [`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#countryprefix) + + + +Connection}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#currentconnection) + + + +Error}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#errors) + + + + +{/*> **hasErrors**: `boolean`*/} + +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 [`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#haserrors) + + + + +{/*> **isPasskeyEnabled**: `boolean`*/} + +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) + + + + +{/*> **locale**: `string`*/} + +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 [`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#locale) + + + +IdentifierType}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/signup-password.ts#L43) + + + +PasswordPolicy}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/signup-password.ts#L41) + + + +IdentifierType}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/signup-password.ts#L42) + + + + +{/*> **state**: `string`*/} + +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 [`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#state) + \ 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..2795d1ee5 --- /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/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/mfa-otp-challenge.ts#L38) + +Options for trying another method + + + +```ts Example +export interface TryAnotherMethodOptions { + /** Any additional custom options */ + [key: string]: string | number | boolean | undefined; +} +``` + + +## 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..4ad7ff2df --- /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/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/reset-password-mfa-email-challenge.ts#L37) + +Options for trying another method. + + + +```ts Example +export interface TryAnotherMethodOptions { + /** Any additional custom options */ + [key: string]: string | number | boolean | undefined; +} +``` + + +## 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..3914dcb90 --- /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/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/screens/mfa-email-challenge.ts#L49) + +Options for trying another method + + + +```ts Example +export interface TryAnotherMethodOptions { + /** Any additional custom options */ + [key: string]: string | number | boolean | undefined; +} +``` + + +## 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..8d15a6aeb --- /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/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/untrusted-data.ts#L14) + + + +```ts Example +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; +} +``` + + +## 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 + + +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/untrusted-data.ts#L16) + + + + +{/*> **submittedFormData**: \{\[`key`: `string`\]: `string` \| `number` \| `boolean` \| `null` \| `undefined`; \} \| `null`*/} + +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) + \ 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..1425a63dc --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembersOnMfaEmailChallenge.mdx @@ -0,0 +1,39 @@ +--- +title: "UntrustedDataMembersOnMfaEmailChallenge" +--- + +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 + + + +```ts Example +export interface UntrustedDataMembersOnMfaEmailChallenge extends UntrustedDataMembers { + submittedFormData: { + rememberDevice: boolean; + } | null; +} +``` + + +- Extends [`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers) + +## Properties + + +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#authorizationparams) + + + + +{/*> **submittedFormData**: \{ `rememberDevice`: `boolean`; \} \| `null`*/} + +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 [`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#submittedformdata) + \ 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..1852cde98 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembersOnMfaOtpChallenge.mdx @@ -0,0 +1,39 @@ +--- +title: "UntrustedDataMembersOnMfaOtpChallenge" +--- + +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 + + + +```ts Example +export interface UntrustedDataMembersOnMfaOtpChallenge extends UntrustedDataMembers { + submittedFormData: { + rememberDevice: boolean; + } | null; +} +``` + + +- Extends [`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers) + +## Properties + + +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#authorizationparams) + + + + +{/*> **submittedFormData**: \{ `rememberDevice`: `boolean`; \} \| `null`*/} + +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 [`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#submittedformdata) + \ 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..657a5b3ae --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembersOnMfaPushChallengePush.mdx @@ -0,0 +1,35 @@ +--- +title: "UntrustedDataMembersOnMfaPushChallengePush" +--- + +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 + + + +```ts Example +export interface UntrustedDataMembersOnMfaPushChallengePush +``` + + +- Extends [`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers) + +## Properties + + +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#authorizationparams) + + + + +{/*> **submittedFormData**: \{ `rememberDevice`: `boolean`; \} \| `null`*/} + +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 [`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#submittedformdata) + \ 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..1019fb64e --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembersOnMfaSmsChallenge.mdx @@ -0,0 +1,39 @@ +--- +title: "UntrustedDataMembersOnMfaSmsChallenge" +--- + +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 + + + +```ts Example +export interface UntrustedDataMembersOnMfaSmsChallenge extends UntrustedDataMembers { + submittedFormData: { + rememberDevice: boolean; + } | null; +} +``` + + +- Extends [`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers) + +## Properties + + +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#authorizationparams) + + + + +{/*> **submittedFormData**: \{ `rememberDevice`: `boolean`; \} \| `null`*/} + +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 [`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#submittedformdata) + \ 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..39babccd1 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembersOnMfaVoiceChallenge.mdx @@ -0,0 +1,39 @@ +--- +title: "UntrustedDataMembersOnMfaVoiceChallenge" +--- + +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 + + + +```ts Example +export interface UntrustedDataMembersOnMfaVoiceChallenge extends UntrustedDataMembers { + submittedFormData: { + rememberDevice: boolean; + } | null; +} +``` + + +- Extends [`UntrustedDataMembers`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers) + +## Properties + + +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/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#authorizationparams) + + + + +{/*> **submittedFormData**: \{ `rememberDevice`: `boolean`; \} \| `null`*/} + +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 [`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#submittedformdata) + \ 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..5e31d7ae7 --- /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/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/user.ts#L39) + + + +```ts Example +export interface UserMembers { + id: string | null; + email: string | null; + username: string | null; + phoneNumber: string | null; + picture: string | null; + enrolledFactors: Array | null; + enrolledEmails: Array | null; + enrolledPhoneNumbers: Array | null; + enrolledDevices: Array | null; + organizations: Organizations[] | null; + userMetadata: { [key: string]: string } | null; + appMetadata: { [key: string]: string } | null; +} +``` + + +## Properties + + +{/*> **appMetadata**: \{\[`key`: `string`\]: `string`; \} \| `null`*/} + +Defined in: [interfaces/models/user.ts:51](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/user.ts#L51) + + + + +{/*> **email**: `string` \| `null`*/} + +Defined in: [interfaces/models/user.ts:41](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/user.ts#L41) + + + +EnrolledDevice}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/user.ts#L48) + + + +EnrolledEmail}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/user.ts#L46) + + + + +{/*> **enrolledFactors**: `string`[] \| `null`*/} + +Defined in: [interfaces/models/user.ts:45](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/user.ts#L45) + + + +EnrolledPhoneNumber}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/user.ts#L47) + + + + +{/*> **id**: `string` \| `null`*/} + +Defined in: [interfaces/models/user.ts:40](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/user.ts#L40) + + + +Organizations}> +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/user.ts#L49) + + + + +{/*> **phoneNumber**: `string` \| `null`*/} + +Defined in: [interfaces/models/user.ts:43](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/user.ts#L43) + + + + +{/*> **picture**: `string` \| `null`*/} + +Defined in: [interfaces/models/user.ts:44](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/user.ts#L44) + + + + +{/*> **userMetadata**: \{\[`key`: `string`\]: `string`; \} \| `null`*/} + +Defined in: [interfaces/models/user.ts:50](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/user.ts#L50) + + + + +{/*> **username**: `string` \| `null`*/} + +Defined in: [interfaces/models/user.ts:42](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/user.ts#L42) + \ 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..b6ab62e07 --- /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/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/transaction.ts#L47) + + + +```ts Example +export interface UsernamePolicy { + isActive?: boolean + maxLength: number; + minLength: number; + allowedFormats?: { + usernameInEmailFormat?: boolean; + usernameInPhoneFormat?: boolean; + }; +} +``` + + +## Properties + + +{/*> `optional` **allowedFormats**: `object`*/} + +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? + +{/*> `optional` **usernameInEmailFormat**: `boolean`*/} + +#### usernameInPhoneFormat? + +{/*> `optional` **usernameInPhoneFormat**: `boolean`*/} + + + + +{/*> `optional` **isActive**: `boolean`*/} + +Defined in: [interfaces/models/transaction.ts:48](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/transaction.ts#L48) + + + + +{/*> **maxLength**: `number`*/} + +Defined in: [interfaces/models/transaction.ts:49](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/transaction.ts#L49) + + + + +{/*> **minLength**: `number`*/} + +Defined in: [interfaces/models/transaction.ts:50](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/transaction.ts#L50) + \ 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..aa3e9df9c --- /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/5c054686de6099ea69493d68134be65604477bb6/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`. + + + +```ts Example +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; +} +``` + + +## Properties + + +{/*> **code**: `string`*/} + +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. + +Example: `"username-too-short"`, `"username-invalid-characters"` + + + + +{/*> **field**: `string`*/} + +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". + + + + +{/*> **message**: `string`*/} + +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. + +Example: `"Username must be at least 3 characters long."` + \ 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..aadf36184 --- /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/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/utils/validate-username.ts#L31) + +The result of validating a username against one or more rules. + + + +```ts Example +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[]; +} +``` + + +## Properties + +UsernameValidationError}> +{/*> **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/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. + +This array is empty if [UsernameValidationResult.isValid](#isvalid) is `true`. + + + + +{/*> **isValid**: `boolean`*/} + +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. + \ 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..82074441f --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/VerifyPlatformAuthenticatorOptions.mdx @@ -0,0 +1,38 @@ +--- +title: "VerifyPlatformAuthenticatorOptions" +--- + +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 + + + +```ts Example +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; +} +``` + + +- Extends [`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CustomOptions) + +## Indexable + +\[`key`: `string`\]: `string` \| `number` \| `boolean` \| `undefined` + +## Properties + + +{/*> `optional` **rememberDevice**: `boolean`*/} + +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. + \ 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..b32abe5ab --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/VerifySecurityKeyOptions.mdx @@ -0,0 +1,33 @@ +--- +title: "VerifySecurityKeyOptions" +--- + +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 + + + +```ts Example +export interface VerifySecurityKeyOptions extends CustomOptions { + rememberDevice?: boolean; +} +``` + + +- Extends [`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CustomOptions) + +## Indexable + +\[`key`: `string`\]: `string` \| `number` \| `boolean` \| `undefined` + +## Properties + + +{/*> `optional` **rememberDevice**: `boolean`*/} + +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. + \ 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..1b5e7c2a5 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/WebAuthnEnrollSuccessContinueOptions.mdx @@ -0,0 +1,23 @@ +--- +title: "WebAuthnEnrollSuccessContinueOptions" +--- + +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 + + + +```ts Example +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. +} +``` + + +- 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..46c98c3c1 --- /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/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/common/index.ts#L9) + +Details of a WebAuthn browser error. + + + +```ts Example +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; +} +``` + + +## Indexable + +\[`key`: `string`\]: `string` \| `number` \| `boolean` \| `undefined` + +Any additional error properties. + +## Properties + + +{/*> **message**: `string`*/} + +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. + + + + +{/*> **name**: `string`*/} + +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"). + \ 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..18f3b5bf7 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/WithRememberOptions.mdx @@ -0,0 +1,28 @@ +--- +title: "WithRememberOptions" +--- + +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) + + + +```ts Example +export interface WithRememberOptions extends CustomOptions { + rememberDevice?: boolean; +} +``` + + +- Extends [`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CustomOptions) + +## Indexable + +\[`key`: `string`\]: `string` \| `number` \| `boolean` \| `undefined` + +## Properties + + +{/*> `optional` **rememberDevice**: `boolean`*/} + +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) + \ 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..0deb50171 --- /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" +--- + + +{/*> **AuthenticatorTransport** = `"usb"` \| `"nfc"` \| `"ble"` \| `"internal"` \| `"hybrid"`*/} + +Defined in: [interfaces/models/screen.ts:8](https://github.com/auth0/universal-login/blob/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/interfaces/models/screen.ts#L8) + + + +```ts Example +export type AuthenticatorTransport = 'usb' | 'nfc' | 'ble' | 'internal' | 'hybrid'; +``` + + \ 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..bd0c86abc --- /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" +--- + + +{/*> **IdentifierType** = `"phone"` \| `"email"` \| `"username"`*/} + +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 + + + +```ts Example +export type IdentifierType = 'phone' | 'email' | 'username'; +``` + + \ 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..e42ea1c1f --- /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" +--- + + +{/*> **MfaEnrollFactorType** = `"push-notification"` \| `"otp"` \| `"sms"` \| `"phone"` \| `"voice"` \| `"webauthn-roaming"`*/} + +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 + + + +```ts Example +export type MfaEnrollFactorType = 'push-notification' | 'otp' | 'sms' | 'phone' | 'voice' | 'webauthn-roaming'; +``` + + \ 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..fa18dec21 --- /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" +--- + + +{/*> **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/5c054686de6099ea69493d68134be65604477bb6/packages/auth0-acul-js/src/constants/mfa-factors.ts#L36) + +Type definition for MFA login factor constants + + + +```ts Example +export type MfaLoginFactorType = + | 'push-notification' + | 'otp' + | 'sms' + | 'phone' + | 'voice' + | 'email' + | 'recovery-code' + | 'webauthn-roaming' + | 'webauthn-platform' + | 'duo'; +``` + + \ 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..c75008ad0 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/type-aliases/MfaPollingOptions.mdx @@ -0,0 +1,109 @@ +--- +title: "Type Alias: MfaPollingOptions" +--- + + +{/*> **MfaPollingOptions** = `object`*/} + +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. + +Supply these options when starting a polling session to control how often +the challenge endpoint is queried and how success or failure is handled. + + + +{/*> `optional` **intervalMs**: `number`*/} + +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. + +- 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) +``` + + + +{/*> `optional` **onCompleted**: () => `void`*/} + +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. + +- Called exactly **once**, after which polling stops automatically. +- Useful for advancing the login flow (e.g., calling `continue()`). + +- Returns `void` + + + +{/*> `optional` **onError**: (`error`) => `void`*/} + +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. + +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. + + +Error}> +[`Error`](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Error) + + + +- Returns `void` + + + + + + +```ts Example +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; +}; +``` + + \ 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..e18bd2491 --- /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" +--- + + +{/*> **OnStatusChangeCallback** = (`remainingSeconds`, `isDisabled`) => `void`*/} + +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. + + + +`number` + +Number of seconds remaining in the countdown + + +`boolean` + +Whether the resend functionality is currently disabled + + + +## Returns + +`void` + + + +```ts Example +export type OnStatusChangeCallback = (remainingSeconds: number, isDisabled: boolean) => void; +``` + + \ 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..ef7109e54 --- /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" +--- + + +{/*> **ScreenIdentifierType** = `"email"` \| `"phone"` \| `"username"`*/} + +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. + +- `'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. + + +```ts Example +const type: IdentifierType = 'email'; +``` + + + +``` \ 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..40f0d3938 --- /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" +--- + + +{/*> **WebAuthnType** = `"webauthn-roaming"` \| `"webauthn-platform"`*/} + +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) + + + +```ts Example +export type WebAuthnType = 'webauthn-roaming' | 'webauthn-platform'; +``` + + \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Types/index.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Types/index.mdx new file mode 100644 index 000000000..f47da8320 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Types/index.mdx @@ -0,0 +1,1683 @@ +--- +title: "Types" +--- + +## References + +### AbortEnrollmentOptions + +Re-exports [AbortEnrollmentOptions](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/AbortEnrollmentOptions) + +*** + +### AcceptInvitationMembers + +Re-exports [AcceptInvitationMembers](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/AcceptInvitationMembers) + +*** + +### AllowCredential + +Re-exports [AllowCredential](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/AllowCredential) + +*** + +### AuthenticatorTransport + +Re-exports [AuthenticatorTransport](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/type-aliases/AuthenticatorTransport) + +*** + +### AuthorizationDetail + +Re-exports [AuthorizationDetail](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/AuthorizationDetail) + +*** + +### BaseMembers + +Re-exports [BaseMembers](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BaseMembers) + +*** + +### Branding + +Re-exports [Branding](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Branding) + +*** + +### BrandingMembers + +Re-exports [BrandingMembers](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingMembers) + +*** + +### BrandingSettings + +Re-exports [BrandingSettings](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingSettings) + +*** + +### BrandingThemes + +Re-exports [BrandingThemes](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/BrandingThemes) + +*** + +### CaptchaContext + +Re-exports [CaptchaContext](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CaptchaContext) + +*** + +### ClientMembers + +Re-exports [ClientMembers](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ClientMembers) + +*** + +### ConfirmLogoutOptions + +Re-exports [ConfirmLogoutOptions](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ConfirmLogoutOptions) + +*** + +### Connection + +Re-exports [Connection](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Connection) + +*** + +### ConsentMembers + +Re-exports [ConsentMembers](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ConsentMembers) + +*** + +### ContinueOptions + +Re-exports [ContinueOptions](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ContinueOptions) + +*** + +### ContinueOTPOptions + +Re-exports [ContinueOTPOptions](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ContinueOTPOptions) + +*** + +### ContinuePayloadOptions + +Re-exports [ContinuePayloadOptions](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ContinuePayloadOptions) + +*** + +### ContinueWithCodeOptionPayload + +Re-exports [ContinueWithCodeOptionPayload](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ContinueWithCodeOptionPayload) + +*** + +### ContinueWithOrganizationNameOptions + +Re-exports [ContinueWithOrganizationNameOptions](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ContinueWithOrganizationNameOptions) + +*** + +### CredentialResponse + +Re-exports [CredentialResponse](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CredentialResponse) + +*** + +### CurrentScreenOptions + +Re-exports [CurrentScreenOptions](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CurrentScreenOptions) + +*** + +### CustomizedConsentMembers + +Re-exports [CustomizedConsentMembers](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CustomizedConsentMembers) + +*** + +### CustomOptions + +Re-exports [CustomOptions](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/CustomOptions) + +*** + +### DeviceCodeActivationAllowedMembers + +Re-exports [DeviceCodeActivationAllowedMembers](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/DeviceCodeActivationAllowedMembers) + +*** + +### DeviceCodeActivationContinueOptions + +Re-exports [DeviceCodeActivationContinueOptions](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/DeviceCodeActivationContinueOptions) + +*** + +### DeviceCodeActivationDeniedMembers + +Re-exports [DeviceCodeActivationDeniedMembers](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/DeviceCodeActivationDeniedMembers) + +*** + +### DeviceCodeActivationMembers + +Re-exports [DeviceCodeActivationMembers](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/DeviceCodeActivationMembers) + +*** + +### DeviceCodeConfirmationMembers + +Re-exports [DeviceCodeConfirmationMembers](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/DeviceCodeConfirmationMembers) + +*** + +### EmailChallengeOptions + +Re-exports [EmailChallengeOptions](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/EmailChallengeOptions) + +*** + +### EmailIdentifierChallengeMembers + +Re-exports [EmailIdentifierChallengeMembers](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/EmailIdentifierChallengeMembers) + +*** + +### EmailOTPChallengeMembers + +Re-exports [EmailOTPChallengeMembers](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/EmailOTPChallengeMembers) + +*** + +### EmailVerificationResultMembers + +Re-exports [EmailVerificationResultMembers](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/EmailVerificationResultMembers) + +*** + +### EnrolledDevice + +Re-exports [EnrolledDevice](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/EnrolledDevice) + +*** + +### EnrolledEmail + +Re-exports [EnrolledEmail](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/EnrolledEmail) + +*** + +### EnrolledPhoneNumber + +Re-exports [EnrolledPhoneNumber](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/EnrolledPhoneNumber) + +*** + +### EnterpriseConnection + +Re-exports [EnterpriseConnection](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/EnterpriseConnection) + +*** + +### Error + +Re-exports [Error](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Error) + +*** + +### FederatedLoginOptions + +Re-exports [FederatedLoginOptions](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/FederatedLoginOptions) + +*** + +### FederatedLoginPasswordOptions + +Re-exports [FederatedLoginPasswordOptions](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/FederatedLoginPasswordOptions) + +*** + +### FederatedLoginPayloadOptions + +Re-exports [FederatedLoginPayloadOptions](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/FederatedLoginPayloadOptions) + +*** + +### FederatedSignupOptions + +Re-exports [FederatedSignupOptions](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/FederatedSignupOptions) + +*** + +### FederatedSignupPasswordPayloadOptions + +Re-exports [FederatedSignupPasswordPayloadOptions](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/FederatedSignupPasswordPayloadOptions) + +*** + +### FederatedSignupPayloadOptions + +Re-exports [FederatedSignupPayloadOptions](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/FederatedSignupPayloadOptions) + +*** + +### FlattenedTheme + +Re-exports [FlattenedTheme](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/FlattenedTheme) + +*** + +### Identifier + +Re-exports [Identifier](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Identifier) + +*** + +### IdentifierType + +Re-exports [IdentifierType](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/type-aliases/IdentifierType) + +*** + +### InterstitialCaptchaMembers + +Re-exports [InterstitialCaptchaMembers](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/InterstitialCaptchaMembers) + +*** + +### LoginEmailVerificationMembers + +Re-exports [LoginEmailVerificationMembers](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/LoginEmailVerificationMembers) + +*** + +### LoginEnrollOptions + +Re-exports [LoginEnrollOptions](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/LoginEnrollOptions) + +*** + +### LoginIdMembers + +Re-exports [LoginIdMembers](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/LoginIdMembers) + +*** + +### LoginMembers + +Re-exports [LoginMembers](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/LoginMembers) + +*** + +### LoginOptions + +Re-exports [LoginOptions](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/LoginOptions) + +*** + +### LoginPasswordlessEmailCodeMembers + +Re-exports [LoginPasswordlessEmailCodeMembers](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/LoginPasswordlessEmailCodeMembers) + +*** + +### LoginPasswordlessSmsOtpMembers + +Re-exports [LoginPasswordlessSmsOtpMembers](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/LoginPasswordlessSmsOtpMembers) + +*** + +### LoginPasswordMembers + +Re-exports [LoginPasswordMembers](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/LoginPasswordMembers) + +*** + +### LoginPasswordOptions + +Re-exports [LoginPasswordOptions](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/LoginPasswordOptions) + +*** + +### LoginPayloadOptions + +Re-exports [LoginPayloadOptions](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/LoginPayloadOptions) + +*** + +### LogoutAbortedMembers + +Re-exports [LogoutAbortedMembers](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/LogoutAbortedMembers) + +*** + +### LogoutCompleteMembers + +Re-exports [LogoutCompleteMembers](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/LogoutCompleteMembers) + +*** + +### LogoutMembers + +Re-exports [LogoutMembers](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/LogoutMembers) + +*** + +### MfaBeginEnrollOptionsMembers + +Re-exports [MfaBeginEnrollOptionsMembers](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaBeginEnrollOptionsMembers) + +*** + +### MfaCountryCodesMembers + +Re-exports [MfaCountryCodesMembers](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaCountryCodesMembers) + +*** + +### MfaDetectBrowserCapabilitiesMembers + +Re-exports [MfaDetectBrowserCapabilitiesMembers](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaDetectBrowserCapabilitiesMembers) + +*** + +### MfaEmailChallengeMembers + +Re-exports [MfaEmailChallengeMembers](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaEmailChallengeMembers) + +*** + +### MfaEmailListMembers + +Re-exports [MfaEmailListMembers](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaEmailListMembers) + +*** + +### MfaEnrollFactorType + +Re-exports [MfaEnrollFactorType](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/type-aliases/MfaEnrollFactorType) + +*** + +### MfaEnrollOptions + +Re-exports [MfaEnrollOptions](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaEnrollOptions) + +*** + +### MfaEnrollResultMembers + +Re-exports [MfaEnrollResultMembers](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaEnrollResultMembers) + +*** + +### MfaLoginFactorType + +Re-exports [MfaLoginFactorType](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/type-aliases/MfaLoginFactorType) + +*** + +### MfaLoginOptionsMembers + +Re-exports [MfaLoginOptionsMembers](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaLoginOptionsMembers) + +*** + +### MfaOtpChallengeMembers + +Re-exports [MfaOtpChallengeMembers](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaOtpChallengeMembers) + +*** + +### MfaOtpContinueOptions + +Re-exports [MfaOtpContinueOptions](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaOtpContinueOptions) + +*** + +### MfaOtpEnrollmentCodeMembers + +Re-exports [MfaOtpEnrollmentCodeMembers](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaOtpEnrollmentCodeMembers) + +*** + +### MfaOtpEnrollmentQrContinueOptions + +Re-exports [MfaOtpEnrollmentQrContinueOptions](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaOtpEnrollmentQrContinueOptions) + +*** + +### MfaOtpEnrollmentQrMembers + +Re-exports [MfaOtpEnrollmentQrMembers](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaOtpEnrollmentQrMembers) + +*** + +### MfaOtpTryAnotherMethodOptions + +Re-exports [MfaOtpTryAnotherMethodOptions](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaOtpTryAnotherMethodOptions) + +*** + +### MfaPhoneChallengeContinueOptions + +Re-exports [MfaPhoneChallengeContinueOptions](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaPhoneChallengeContinueOptions) + +*** + +### MfaPhoneChallengeMembers + +Re-exports [MfaPhoneChallengeMembers](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaPhoneChallengeMembers) + +*** + +### MfaPhoneChallengePickAuthenticatorOptions + +Re-exports [MfaPhoneChallengePickAuthenticatorOptions](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaPhoneChallengePickAuthenticatorOptions) + +*** + +### MfaPhoneChallengePickPhoneOptions + +Re-exports [MfaPhoneChallengePickPhoneOptions](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaPhoneChallengePickPhoneOptions) + +*** + +### MfaPhoneEnrollmentContinueOptions + +Re-exports [MfaPhoneEnrollmentContinueOptions](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaPhoneEnrollmentContinueOptions) + +*** + +### MfaPhoneEnrollmentMembers + +Re-exports [MfaPhoneEnrollmentMembers](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaPhoneEnrollmentMembers) + +*** + +### MfaPollingOptions + +Re-exports [MfaPollingOptions](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/type-aliases/MfaPollingOptions) + +*** + +### MfaPushChallengePushMembers + +Re-exports [MfaPushChallengePushMembers](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaPushChallengePushMembers) + +*** + +### MfaPushEnrollmentQrMembers + +Re-exports [MfaPushEnrollmentQrMembers](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaPushEnrollmentQrMembers) + +*** + +### MfaPushListMembers + +Re-exports [MfaPushListMembers](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaPushListMembers) + +*** + +### MfaPushPollingControl + +Re-exports [MfaPushPollingControl](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaPushPollingControl) + +*** + +### MfaPushWelcomeMembers + +Re-exports [MfaPushWelcomeMembers](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaPushWelcomeMembers) + +*** + +### MfaRecoveryCodeChallengeContinueOptions + +Re-exports [MfaRecoveryCodeChallengeContinueOptions](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaRecoveryCodeChallengeContinueOptions) + +*** + +### MfaRecoveryCodeChallengeMembers + +Re-exports [MfaRecoveryCodeChallengeMembers](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaRecoveryCodeChallengeMembers) + +*** + +### MfaRecoveryCodeChallengeNewCodeContinueOptions + +Re-exports [MfaRecoveryCodeChallengeNewCodeContinueOptions](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaRecoveryCodeChallengeNewCodeContinueOptions) + +*** + +### MfaRecoveryCodeChallengeNewCodeMembers + +Re-exports [MfaRecoveryCodeChallengeNewCodeMembers](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaRecoveryCodeChallengeNewCodeMembers) + +*** + +### MfaRecoveryCodeEnrollmentContinueOptions + +Re-exports [MfaRecoveryCodeEnrollmentContinueOptions](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaRecoveryCodeEnrollmentContinueOptions) + +*** + +### MfaRecoveryCodeEnrollmentMembers + +Re-exports [MfaRecoveryCodeEnrollmentMembers](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaRecoveryCodeEnrollmentMembers) + +*** + +### MfaSmsChallengeMembers + +Re-exports [MfaSmsChallengeMembers](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaSmsChallengeMembers) + +*** + +### MfaSmsChallengeOptions + +Re-exports [MfaSmsChallengeOptions](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaSmsChallengeOptions) + +*** + +### MfaSmsEnrollmentMembers + +Re-exports [MfaSmsEnrollmentMembers](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaSmsEnrollmentMembers) + +*** + +### MfaSmsEnrollmentOptions + +Re-exports [MfaSmsEnrollmentOptions](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaSmsEnrollmentOptions) + +*** + +### MfaSmsListMembers + +Re-exports [MfaSmsListMembers](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaSmsListMembers) + +*** + +### MfaSmsListOptions + +Re-exports [MfaSmsListOptions](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaSmsListOptions) + +*** + +### MfaVoiceChallengeContinueOptions + +Re-exports [MfaVoiceChallengeContinueOptions](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaVoiceChallengeContinueOptions) + +*** + +### MfaVoiceChallengeMembers + +Re-exports [MfaVoiceChallengeMembers](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaVoiceChallengeMembers) + +*** + +### MfaVoiceEnrollmentContinueOptions + +Re-exports [MfaVoiceEnrollmentContinueOptions](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaVoiceEnrollmentContinueOptions) + +*** + +### MfaVoiceEnrollmentMembers + +Re-exports [MfaVoiceEnrollmentMembers](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaVoiceEnrollmentMembers) + +*** + +### MfaWebAuthnChangeKeyNicknameContinueOptions + +Re-exports [MfaWebAuthnChangeKeyNicknameContinueOptions](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaWebAuthnChangeKeyNicknameContinueOptions) + +*** + +### MfaWebAuthnChangeKeyNicknameMembers + +Re-exports [MfaWebAuthnChangeKeyNicknameMembers](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaWebAuthnChangeKeyNicknameMembers) + +*** + +### MfaWebAuthnEnrollmentSuccessMembers + +Re-exports [MfaWebAuthnEnrollmentSuccessMembers](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaWebAuthnEnrollmentSuccessMembers) + +*** + +### MfaWebAuthnErrorMembers + +Re-exports [MfaWebAuthnErrorMembers](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaWebAuthnErrorMembers) + +*** + +### MfaWebAuthnNotAvailableErrorMembers + +Re-exports [MfaWebAuthnNotAvailableErrorMembers](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaWebAuthnNotAvailableErrorMembers) + +*** + +### MfaWebAuthnPlatformChallengeMembers + +Re-exports [MfaWebAuthnPlatformChallengeMembers](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaWebAuthnPlatformChallengeMembers) + +*** + +### MfaWebAuthnPlatformChallengeReportErrorOptions + +Re-exports [MfaWebAuthnPlatformChallengeReportErrorOptions](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaWebAuthnPlatformChallengeReportErrorOptions) + +*** + +### MfaWebAuthnPlatformChallengeTryAnotherMethodOptions + +Re-exports [MfaWebAuthnPlatformChallengeTryAnotherMethodOptions](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaWebAuthnPlatformChallengeTryAnotherMethodOptions) + +*** + +### MfaWebAuthnPlatformEnrollmentMembers + +Re-exports [MfaWebAuthnPlatformEnrollmentMembers](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaWebAuthnPlatformEnrollmentMembers) + +*** + +### MfaWebAuthnRoamingChallengeMembers + +Re-exports [MfaWebAuthnRoamingChallengeMembers](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaWebAuthnRoamingChallengeMembers) + +*** + +### MfaWebAuthnRoamingChallengeReportErrorOptions + +Re-exports [MfaWebAuthnRoamingChallengeReportErrorOptions](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaWebAuthnRoamingChallengeReportErrorOptions) + +*** + +### MfaWebAuthnRoamingChallengeTryAnotherMethodOptions + +Re-exports [MfaWebAuthnRoamingChallengeTryAnotherMethodOptions](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaWebAuthnRoamingChallengeTryAnotherMethodOptions) + +*** + +### MfaWebAuthnRoamingEnrollmentMembers + +Re-exports [MfaWebAuthnRoamingEnrollmentMembers](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaWebAuthnRoamingEnrollmentMembers) + +*** + +### MfaWebAuthnRoamingEnrollmentTryAnotherMethodOptions + +Re-exports [MfaWebAuthnRoamingEnrollmentTryAnotherMethodOptions](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/MfaWebAuthnRoamingEnrollmentTryAnotherMethodOptions) + +*** + +### OnStatusChangeCallback + +Re-exports [OnStatusChangeCallback](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/type-aliases/OnStatusChangeCallback) + +*** + +### OrganizationMembers + +Re-exports [OrganizationMembers](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationMembers) + +*** + +### OrganizationPickerMembers + +Re-exports [OrganizationPickerMembers](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationPickerMembers) + +*** + +### Organizations + +Re-exports [Organizations](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Organizations) + +*** + +### OrganizationSelectionMembers + +Re-exports [OrganizationSelectionMembers](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OrganizationSelectionMembers) + +*** + +### OtpCodeOptions + +Re-exports [OtpCodeOptions](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/OtpCodeOptions) + +*** + +### PasskeyCreate + +Re-exports [PasskeyCreate](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PasskeyCreate) + +*** + +### PasskeyCreateResponse + +Re-exports [PasskeyCreateResponse](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PasskeyCreateResponse) + +*** + +### PasskeyEnrollmentLocalMembers + +Re-exports [PasskeyEnrollmentLocalMembers](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PasskeyEnrollmentLocalMembers) + +*** + +### PasskeyEnrollmentMembers + +Re-exports [PasskeyEnrollmentMembers](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PasskeyEnrollmentMembers) + +*** + +### PasswordComplexityRule + +Re-exports [PasswordComplexityRule](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PasswordComplexityRule) + +*** + +### PasswordPolicy + +Re-exports [PasswordPolicy](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PasswordPolicy) + +*** + +### PasswordValidationResult + +Re-exports [PasswordValidationResult](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PasswordValidationResult) + +*** + +### PhoneChallengeOptions + +Re-exports [PhoneChallengeOptions](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PhoneChallengeOptions) + +*** + +### PhoneEnrollmentOptions + +Re-exports [PhoneEnrollmentOptions](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PhoneEnrollmentOptions) + +*** + +### PhoneIdentifierChallengeMembers + +Re-exports [PhoneIdentifierChallengeMembers](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PhoneIdentifierChallengeMembers) + +*** + +### PhoneIdentifierEnrollmentMembers + +Re-exports [PhoneIdentifierEnrollmentMembers](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PhoneIdentifierEnrollmentMembers) + +*** + +### PhonePrefix + +Re-exports [PhonePrefix](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PhonePrefix) + +*** + +### PromptMembers + +Re-exports [PromptMembers](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/PromptMembers) + +*** + +### RedeemTicketMembers + +Re-exports [RedeemTicketMembers](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/RedeemTicketMembers) + +*** + +### ReportBrowserErrorOptions + +Re-exports [ReportBrowserErrorOptions](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ReportBrowserErrorOptions) + +*** + +### ResendCodeOptions + +Re-exports [ResendCodeOptions](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResendCodeOptions) + +*** + +### ResendCodeOptionsPayload + +Re-exports [ResendCodeOptionsPayload](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResendCodeOptionsPayload) + +*** + +### ResendCodePayloadOptions + +Re-exports [ResendCodePayloadOptions](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResendCodePayloadOptions) + +*** + +### ResendControl + +Re-exports [ResendControl](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResendControl) + +*** + +### ResetPasswordEmailMembers + +Re-exports [ResetPasswordEmailMembers](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordEmailMembers) + +*** + +### ResetPasswordEmailOptions + +Re-exports [ResetPasswordEmailOptions](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordEmailOptions) + +*** + +### ResetPasswordErrorMembers + +Re-exports [ResetPasswordErrorMembers](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordErrorMembers) + +*** + +### ResetPasswordMembers + +Re-exports [ResetPasswordMembers](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMembers) + +*** + +### ResetPasswordMfaEmailChallengeMembers + +Re-exports [ResetPasswordMfaEmailChallengeMembers](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMfaEmailChallengeMembers) + +*** + +### ResetPasswordMfaOtpChallengeContinueOptions + +Re-exports [ResetPasswordMfaOtpChallengeContinueOptions](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMfaOtpChallengeContinueOptions) + +*** + +### ResetPasswordMfaOtpChallengeMembers + +Re-exports [ResetPasswordMfaOtpChallengeMembers](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMfaOtpChallengeMembers) + +*** + +### ResetPasswordMfaOtpChallengeTryAnotherMethodOptions + +Re-exports [ResetPasswordMfaOtpChallengeTryAnotherMethodOptions](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMfaOtpChallengeTryAnotherMethodOptions) + +*** + +### ResetPasswordMfaPhoneChallengeContinueOptions + +Re-exports [ResetPasswordMfaPhoneChallengeContinueOptions](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMfaPhoneChallengeContinueOptions) + +*** + +### ResetPasswordMfaPhoneChallengeMembers + +Re-exports [ResetPasswordMfaPhoneChallengeMembers](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMfaPhoneChallengeMembers) + +*** + +### ResetPasswordMfaPhoneChallengeTryAnotherMethodOptions + +Re-exports [ResetPasswordMfaPhoneChallengeTryAnotherMethodOptions](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMfaPhoneChallengeTryAnotherMethodOptions) + +*** + +### ResetPasswordMfaPushChallengePushMembers + +Re-exports [ResetPasswordMfaPushChallengePushMembers](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMfaPushChallengePushMembers) + +*** + +### ResetPasswordMfaRecoveryCodeChallengeMembers + +Re-exports [ResetPasswordMfaRecoveryCodeChallengeMembers](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMfaRecoveryCodeChallengeMembers) + +*** + +### ResetPasswordMfaSmsChallengeMembers + +Re-exports [ResetPasswordMfaSmsChallengeMembers](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMfaSmsChallengeMembers) + +*** + +### ResetPasswordMfaSmsChallengeOptions + +Re-exports [ResetPasswordMfaSmsChallengeOptions](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMfaSmsChallengeOptions) + +*** + +### ResetPasswordMfaVoiceChallengeContinueOptions + +Re-exports [ResetPasswordMfaVoiceChallengeContinueOptions](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMfaVoiceChallengeContinueOptions) + +*** + +### ResetPasswordMfaVoiceChallengeMembers + +Re-exports [ResetPasswordMfaVoiceChallengeMembers](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMfaVoiceChallengeMembers) + +*** + +### ResetPasswordMfaWebAuthnPlatformChallengeContinueOptions + +Re-exports [ResetPasswordMfaWebAuthnPlatformChallengeContinueOptions](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMfaWebAuthnPlatformChallengeContinueOptions) + +*** + +### ResetPasswordMfaWebAuthnPlatformChallengeMembers + +Re-exports [ResetPasswordMfaWebAuthnPlatformChallengeMembers](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMfaWebAuthnPlatformChallengeMembers) + +*** + +### ResetPasswordMfaWebAuthnPlatformChallengeReportErrorOptions + +Re-exports [ResetPasswordMfaWebAuthnPlatformChallengeReportErrorOptions](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMfaWebAuthnPlatformChallengeReportErrorOptions) + +*** + +### ResetPasswordMfaWebAuthnPlatformChallengeTryAnotherMethodOptions + +Re-exports [ResetPasswordMfaWebAuthnPlatformChallengeTryAnotherMethodOptions](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMfaWebAuthnPlatformChallengeTryAnotherMethodOptions) + +*** + +### ResetPasswordMfaWebAuthnRoamingChallengeMembers + +Re-exports [ResetPasswordMfaWebAuthnRoamingChallengeMembers](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMfaWebAuthnRoamingChallengeMembers) + +*** + +### ResetPasswordMfaWebAuthnRoamingChallengeShowErrorOptions + +Re-exports [ResetPasswordMfaWebAuthnRoamingChallengeShowErrorOptions](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMfaWebAuthnRoamingChallengeShowErrorOptions) + +*** + +### ResetPasswordMfaWebAuthnRoamingChallengeTryAnotherMethodOptions + +Re-exports [ResetPasswordMfaWebAuthnRoamingChallengeTryAnotherMethodOptions](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMfaWebAuthnRoamingChallengeTryAnotherMethodOptions) + +*** + +### ResetPasswordMfaWebAuthnRoamingChallengeUseSecurityKeyOptions + +Re-exports [ResetPasswordMfaWebAuthnRoamingChallengeUseSecurityKeyOptions](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordMfaWebAuthnRoamingChallengeUseSecurityKeyOptions) + +*** + +### ResetPasswordOptions + +Re-exports [ResetPasswordOptions](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordOptions) + +*** + +### ResetPasswordRequestMembers + +Re-exports [ResetPasswordRequestMembers](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordRequestMembers) + +*** + +### ResetPasswordRequestOptions + +Re-exports [ResetPasswordRequestOptions](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordRequestOptions) + +*** + +### ResetPasswordSuccessMembers + +Re-exports [ResetPasswordSuccessMembers](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ResetPasswordSuccessMembers) + +*** + +### Scope + +Re-exports [Scope](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Scope) + +*** + +### ScreenIdentifierType + +Re-exports [ScreenIdentifierType](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/type-aliases/ScreenIdentifierType) + +*** + +### ScreenMembers + +Re-exports [ScreenMembers](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembers) + +*** + +### ScreenMembersOnAcceptInvitation + +Re-exports [ScreenMembersOnAcceptInvitation](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnAcceptInvitation) + +*** + +### ScreenMembersOnConsent + +Re-exports [ScreenMembersOnConsent](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnConsent) + +*** + +### ScreenMembersOnCustomizedConsent + +Re-exports [ScreenMembersOnCustomizedConsent](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnCustomizedConsent) + +*** + +### ScreenMembersOnDeviceCodeConfirmation + +Re-exports [ScreenMembersOnDeviceCodeConfirmation](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnDeviceCodeConfirmation) + +*** + +### ScreenMembersOnEmailIdentifierChallenge + +Re-exports [ScreenMembersOnEmailIdentifierChallenge](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnEmailIdentifierChallenge) + +*** + +### ScreenMembersOnEmailOTPChallenge + +Re-exports [ScreenMembersOnEmailOTPChallenge](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnEmailOTPChallenge) + +*** + +### ScreenMembersOnEmailVerificationResult + +Re-exports [ScreenMembersOnEmailVerificationResult](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnEmailVerificationResult) + +*** + +### ScreenMembersOnLogin + +Re-exports [ScreenMembersOnLogin](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnLogin) + +*** + +### ScreenMembersOnLoginId + +Re-exports [ScreenMembersOnLoginId](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnLoginId) + +*** + +### ScreenMembersOnLoginPassword + +Re-exports [ScreenMembersOnLoginPassword](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnLoginPassword) + +*** + +### ScreenMembersOnLoginPasswordlessEmailCode + +Re-exports [ScreenMembersOnLoginPasswordlessEmailCode](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnLoginPasswordlessEmailCode) + +*** + +### ScreenMembersOnLoginPasswordlessSmsOtp + +Re-exports [ScreenMembersOnLoginPasswordlessSmsOtp](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnLoginPasswordlessSmsOtp) + +*** + +### ScreenMembersOnMfaCountryCodes + +Re-exports [ScreenMembersOnMfaCountryCodes](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnMfaCountryCodes) + +*** + +### ScreenMembersOnMfaEmailChallenge + +Re-exports [ScreenMembersOnMfaEmailChallenge](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnMfaEmailChallenge) + +*** + +### ScreenMembersOnMfaEmailList + +Re-exports [ScreenMembersOnMfaEmailList](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnMfaEmailList) + +*** + +### ScreenMembersOnMfaEnrollResult + +Re-exports [ScreenMembersOnMfaEnrollResult](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnMfaEnrollResult) + +*** + +### ScreenMembersOnMfaLoginOptions + +Re-exports [ScreenMembersOnMfaLoginOptions](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnMfaLoginOptions) + +*** + +### ScreenMembersOnMfaOtpChallenge + +Re-exports [ScreenMembersOnMfaOtpChallenge](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnMfaOtpChallenge) + +*** + +### ScreenMembersOnMfaOtpEnrollmentCode + +Re-exports [ScreenMembersOnMfaOtpEnrollmentCode](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnMfaOtpEnrollmentCode) + +*** + +### ScreenMembersOnMfaOtpEnrollmentQr + +Re-exports [ScreenMembersOnMfaOtpEnrollmentQr](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnMfaOtpEnrollmentQr) + +*** + +### ScreenMembersOnMfaPhoneChallenge + +Re-exports [ScreenMembersOnMfaPhoneChallenge](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnMfaPhoneChallenge) + +*** + +### ScreenMembersOnMfaPushChallengePush + +Re-exports [ScreenMembersOnMfaPushChallengePush](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnMfaPushChallengePush) + +*** + +### ScreenMembersOnMfaPushEnrollmentQr + +Re-exports [ScreenMembersOnMfaPushEnrollmentQr](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnMfaPushEnrollmentQr) + +*** + +### ScreenMembersOnMfaPushWelcome + +Re-exports [ScreenMembersOnMfaPushWelcome](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnMfaPushWelcome) + +*** + +### ScreenMembersOnMfaRecoveryCodeChallengeNewCode + +Re-exports [ScreenMembersOnMfaRecoveryCodeChallengeNewCode](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnMfaRecoveryCodeChallengeNewCode) + +*** + +### ScreenMembersOnMfaRecoveryCodeEnrollment + +Re-exports [ScreenMembersOnMfaRecoveryCodeEnrollment](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnMfaRecoveryCodeEnrollment) + +*** + +### ScreenMembersOnMfaSmsChallenge + +Re-exports [ScreenMembersOnMfaSmsChallenge](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnMfaSmsChallenge) + +*** + +### ScreenMembersOnMfaSmsEnrollment + +Re-exports [ScreenMembersOnMfaSmsEnrollment](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnMfaSmsEnrollment) + +*** + +### ScreenMembersOnMfaVoiceChallenge + +Re-exports [ScreenMembersOnMfaVoiceChallenge](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnMfaVoiceChallenge) + +*** + +### ScreenMembersOnMfaWebAuthnChangeKeyNickname + +Re-exports [ScreenMembersOnMfaWebAuthnChangeKeyNickname](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnMfaWebAuthnChangeKeyNickname) + +*** + +### ScreenMembersOnMfaWebAuthnEnrollmentSuccess + +Re-exports [ScreenMembersOnMfaWebAuthnEnrollmentSuccess](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnMfaWebAuthnEnrollmentSuccess) + +*** + +### ScreenMembersOnMfaWebAuthnError + +Re-exports [ScreenMembersOnMfaWebAuthnError](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnMfaWebAuthnError) + +*** + +### ScreenMembersOnMfaWebAuthnPlatformChallenge + +Re-exports [ScreenMembersOnMfaWebAuthnPlatformChallenge](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnMfaWebAuthnPlatformChallenge) + +*** + +### ScreenMembersOnMfaWebAuthnPlatformEnrollment + +Re-exports [ScreenMembersOnMfaWebAuthnPlatformEnrollment](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnMfaWebAuthnPlatformEnrollment) + +*** + +### ScreenMembersOnMfaWebAuthnRoamingChallenge + +Re-exports [ScreenMembersOnMfaWebAuthnRoamingChallenge](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnMfaWebAuthnRoamingChallenge) + +*** + +### ScreenMembersOnMfaWebAuthnRoamingEnrollment + +Re-exports [ScreenMembersOnMfaWebAuthnRoamingEnrollment](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnMfaWebAuthnRoamingEnrollment) + +*** + +### ScreenMembersOnOrganizationSelection + +Re-exports [ScreenMembersOnOrganizationSelection](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnOrganizationSelection) + +*** + +### ScreenMembersOnPasskeyEnrollment + +Re-exports [ScreenMembersOnPasskeyEnrollment](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnPasskeyEnrollment) + +*** + +### ScreenMembersOnPasskeyEnrollmentLocal + +Re-exports [ScreenMembersOnPasskeyEnrollmentLocal](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnPasskeyEnrollmentLocal) + +*** + +### ScreenMembersOnPhoneIdentifierChallenge + +Re-exports [ScreenMembersOnPhoneIdentifierChallenge](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnPhoneIdentifierChallenge) + +*** + +### ScreenMembersOnPhoneIdentifierEnrollment + +Re-exports [ScreenMembersOnPhoneIdentifierEnrollment](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnPhoneIdentifierEnrollment) + +*** + +### ScreenMembersOnResetPassword + +Re-exports [ScreenMembersOnResetPassword](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnResetPassword) + +*** + +### ScreenMembersOnResetPasswordEmail + +Re-exports [ScreenMembersOnResetPasswordEmail](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnResetPasswordEmail) + +*** + +### ScreenMembersOnResetPasswordError + +Re-exports [ScreenMembersOnResetPasswordError](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnResetPasswordError) + +*** + +### ScreenMembersOnResetPasswordMfaEmailChallenge + +Re-exports [ScreenMembersOnResetPasswordMfaEmailChallenge](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnResetPasswordMfaEmailChallenge) + +*** + +### ScreenMembersOnResetPasswordMfaPhoneChallenge + +Re-exports [ScreenMembersOnResetPasswordMfaPhoneChallenge](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnResetPasswordMfaPhoneChallenge) + +*** + +### ScreenMembersOnResetPasswordMfaPushChallengePush + +Re-exports [ScreenMembersOnResetPasswordMfaPushChallengePush](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnResetPasswordMfaPushChallengePush) + +*** + +### ScreenMembersOnResetPasswordMfaSmsChallenge + +Re-exports [ScreenMembersOnResetPasswordMfaSmsChallenge](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnResetPasswordMfaSmsChallenge) + +*** + +### ScreenMembersOnResetPasswordMfaVoiceChallenge + +Re-exports [ScreenMembersOnResetPasswordMfaVoiceChallenge](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnResetPasswordMfaVoiceChallenge) + +*** + +### ScreenMembersOnResetPasswordMfaWebAuthnPlatformChallenge + +Re-exports [ScreenMembersOnResetPasswordMfaWebAuthnPlatformChallenge](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnResetPasswordMfaWebAuthnPlatformChallenge) + +*** + +### ScreenMembersOnResetPasswordMfaWebAuthnRoamingChallenge + +Re-exports [ScreenMembersOnResetPasswordMfaWebAuthnRoamingChallenge](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnResetPasswordMfaWebAuthnRoamingChallenge) + +*** + +### ScreenMembersOnResetPasswordRequest + +Re-exports [ScreenMembersOnResetPasswordRequest](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnResetPasswordRequest) + +*** + +### ScreenMembersOnResetPasswordSuccess + +Re-exports [ScreenMembersOnResetPasswordSuccess](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnResetPasswordSuccess) + +*** + +### ScreenMembersOnSignup + +Re-exports [ScreenMembersOnSignup](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnSignup) + +*** + +### ScreenMembersOnSignupId + +Re-exports [ScreenMembersOnSignupId](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnSignupId) + +*** + +### ScreenMembersOnSignupPassword + +Re-exports [ScreenMembersOnSignupPassword](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ScreenMembersOnSignupPassword) + +*** + +### SelectCountryCodeOptions + +Re-exports [SelectCountryCodeOptions](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/SelectCountryCodeOptions) + +*** + +### SelectMfaEmailOptions + +Re-exports [SelectMfaEmailOptions](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/SelectMfaEmailOptions) + +*** + +### SelectMfaPushDeviceOptions + +Re-exports [SelectMfaPushDeviceOptions](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/SelectMfaPushDeviceOptions) + +*** + +### SelectOrganizationOptions + +Re-exports [SelectOrganizationOptions](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/SelectOrganizationOptions) + +*** + +### ShowErrorOptions + +Re-exports [ShowErrorOptions](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/ShowErrorOptions) + +*** + +### SignupIdMembers + +Re-exports [SignupIdMembers](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/SignupIdMembers) + +*** + +### SignupMembers + +Re-exports [SignupMembers](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/SignupMembers) + +*** + +### SignupOptions + +Re-exports [SignupOptions](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/SignupOptions) + +*** + +### SignupPasswordMembers + +Re-exports [SignupPasswordMembers](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/SignupPasswordMembers) + +*** + +### SignupPasswordOptions + +Re-exports [SignupPasswordOptions](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/SignupPasswordOptions) + +*** + +### SignupPayloadOptions + +Re-exports [SignupPayloadOptions](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/SignupPayloadOptions) + +*** + +### StartResendOptions + +Re-exports [StartResendOptions](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/StartResendOptions) + +*** + +### SubmitCaptchaOptions + +Re-exports [SubmitCaptchaOptions](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/SubmitCaptchaOptions) + +*** + +### SubmitCodeOptions + +Re-exports [SubmitCodeOptions](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/SubmitCodeOptions) + +*** + +### SubmitOTPOptions + +Re-exports [SubmitOTPOptions](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/SubmitOTPOptions) + +*** + +### SubmitPasskeyCredentialOptions + +Re-exports [SubmitPasskeyCredentialOptions](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/SubmitPasskeyCredentialOptions) + +*** + +### TenantMembers + +Re-exports [TenantMembers](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TenantMembers) + +*** + +### TransactionMembers + +Re-exports [TransactionMembers](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembers) + +*** + +### TransactionMembersOnLogin + +Re-exports [TransactionMembersOnLogin](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembersOnLogin) + +*** + +### TransactionMembersOnLoginId + +Re-exports [TransactionMembersOnLoginId](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembersOnLoginId) + +*** + +### TransactionMembersOnLoginPassword + +Re-exports [TransactionMembersOnLoginPassword](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembersOnLoginPassword) + +*** + +### TransactionMembersOnLoginPasswordlessEmailCode + +Re-exports [TransactionMembersOnLoginPasswordlessEmailCode](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembersOnLoginPasswordlessEmailCode) + +*** + +### TransactionMembersOnLoginPasswordlessSmsOtp + +Re-exports [TransactionMembersOnLoginPasswordlessSmsOtp](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembersOnLoginPasswordlessSmsOtp) + +*** + +### TransactionMembersOnResetPassword + +Re-exports [TransactionMembersOnResetPassword](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembersOnResetPassword) + +*** + +### TransactionMembersOnResetPasswordRequest + +Re-exports [TransactionMembersOnResetPasswordRequest](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembersOnResetPasswordRequest) + +*** + +### TransactionMembersOnSignup + +Re-exports [TransactionMembersOnSignup](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembersOnSignup) + +*** + +### TransactionMembersOnSignupId + +Re-exports [TransactionMembersOnSignupId](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembersOnSignupId) + +*** + +### TransactionMembersOnSignupPassword + +Re-exports [TransactionMembersOnSignupPassword](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TransactionMembersOnSignupPassword) + +*** + +### TryAnotherMethodMfaOtpChallengeOptions + +Re-exports [TryAnotherMethodMfaOtpChallengeOptions](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TryAnotherMethodMfaOtpChallengeOptions) + +*** + +### TryAnotherMethodOptions + +Re-exports [TryAnotherMethodOptions](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TryAnotherMethodOptions) + +*** + +### TryAnotherMethodPayloadOptions + +Re-exports [TryAnotherMethodPayloadOptions](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/TryAnotherMethodPayloadOptions) + +*** + +### ULError + +Renames and re-exports [Error](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/Error) + +*** + +### UntrustedDataMembers + +Re-exports [UntrustedDataMembers](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembers) + +*** + +### UntrustedDataMembersOnMfaEmailChallenge + +Re-exports [UntrustedDataMembersOnMfaEmailChallenge](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembersOnMfaEmailChallenge) + +*** + +### UntrustedDataMembersOnMfaOtpChallenge + +Re-exports [UntrustedDataMembersOnMfaOtpChallenge](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembersOnMfaOtpChallenge) + +*** + +### UntrustedDataMembersOnMfaPushChallengePush + +Re-exports [UntrustedDataMembersOnMfaPushChallengePush](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembersOnMfaPushChallengePush) + +*** + +### UntrustedDataMembersOnMfaSmsChallenge + +Re-exports [UntrustedDataMembersOnMfaSmsChallenge](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembersOnMfaSmsChallenge) + +*** + +### UntrustedDataMembersOnMfaVoiceChallenge + +Re-exports [UntrustedDataMembersOnMfaVoiceChallenge](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UntrustedDataMembersOnMfaVoiceChallenge) + +*** + +### UserMembers + +Re-exports [UserMembers](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UserMembers) + +*** + +### UsernamePolicy + +Re-exports [UsernamePolicy](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UsernamePolicy) + +*** + +### UsernameValidationError + +Re-exports [UsernameValidationError](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UsernameValidationError) + +*** + +### UsernameValidationResult + +Re-exports [UsernameValidationResult](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/UsernameValidationResult) + +*** + +### VerifyPlatformAuthenticatorOptions + +Re-exports [VerifyPlatformAuthenticatorOptions](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/VerifyPlatformAuthenticatorOptions) + +*** + +### VerifySecurityKeyOptions + +Re-exports [VerifySecurityKeyOptions](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/VerifySecurityKeyOptions) + +*** + +### WebAuthnEnrollSuccessContinueOptions + +Re-exports [WebAuthnEnrollSuccessContinueOptions](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/WebAuthnEnrollSuccessContinueOptions) + +*** + +### WebAuthnErrorDetails + +Re-exports [WebAuthnErrorDetails](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/WebAuthnErrorDetails) + +*** + +### WebAuthnType + +Re-exports [WebAuthnType](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/type-aliases/WebAuthnType) + +*** + +### WithRememberOptions + +Re-exports [WithRememberOptions](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens/interfaces/WithRememberOptions) \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/_media/FAQ.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/_media/FAQ.mdx new file mode 100644 index 000000000..30b92d03c --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/_media/FAQ.mdx @@ -0,0 +1,94 @@ +--- +title: "Frequently Asked Questions" +--- + +Below are a number of questions or issues that have arisen from using the SDK. + +## How do I import different screens in my project? + +```typescript +// Highlighting default import paths of different screens + +import LoginIdScreen from '@auth0/auth0-acul-js/login-id'; +import LoginPasswordScreen from '@auth0/auth0-acul-js/login-password'; +import SignupScreen from '@auth0/auth0-acul-js/signup-id'; +import SignupPasswordScreen from '@auth0/auth0-acul-js/signup-password'; +``` + +
+ Import of all other screens + +```javascript +import LoginPasswordlessEmailCodeScreen from '@auth0/auth0-acul-js/login-passwordless-email-code'; +import LoginPasswordlessEmailSMSOTP from '@auth0/auth0-acul-js/login-passwordless-sms-otp'; +import PasskeyEnrolmentScreen from '@auth0/auth0-acul-js/passkey-enrollment'; +import PasskeyEnrolmentLocalScreen from '@auth0/auth0-acul-js/passkey-enrollment-local'; +import PhoneIdentifierChallengeScreen from '@auth0/auth0-acul-js/phone-identifier-challenge'; +import PhoneIdentifierEnrolmentScreen from '@auth0/auth0-acul-js/phone-identifier-enrollment'; +import EmailIdentifierChallengeScreen from '@auth0/auth0-acul-js/email-identifier-challenge'; +import InterstitialCaptchaScreen from '@auth0/auth0-acul-js/interstitial-captcha'; +import Login from '@auth0/auth0-acul-js/login'; +import Signup from '@auth0/auth0-acul-js/signup'; +import ResetPassword from '@auth0/auth0-acul-js/reset-password'; +import ResetPasswordRequest from '@auth0/auth0-acul-js/reset-password-request'; +import ResetPasswordEmail from '@auth0/auth0-acul-js/reset-password-email'; +import ResetPasswordSuccess from '@auth0/auth0-acul-js/reset-password-success'; +import ResetPasswordError from '@auth0/auth0-acul-js/reset-password-error'; + +// MFA related screens +import MfaDetectBrowserCapabilities from '@auth0/auth0-acul-js/mfa-detect-browser-capabilities'; +import MfaEnrollResult from '@auth0/auth0-acul-js/mfa-enroll-result'; +import MfaBeginEnrollOptions from '@auth0/auth0-acul-js/mfa-begin-enroll-options'; +import MfaLoginOptions from '@auth0/auth0-acul-js/mfa-login-options'; +import MfaPushEnrollmentQr from '@auth0/auth0-acul-js/mfa-push-enrollment-qr'; +import MfaPushWelcome from '@auth0/auth0-acul-js/mfa-push-welcome'; +import MfaPushChallengePush from '@auth0/auth0-acul-js/mfa-push-challenge-push'; +import MfaPushList from '@auth0/auth0-acul-js/mfa-push-list'; +import MfaCountryCodes from '@auth0/auth0-acul-js/mfa-country-codes'; +import MfaSmsChallenge from '@auth0/auth0-acul-js/mfa-sms-challenge'; +import MfaSmsEnrollment from '@auth0/auth0-acul-js/mfa-sms-enrollment'; +import MfaSmsList from '@auth0/auth0-acul-js/mfa-sms-list'; +import MfaEmailChallenge from '@auth0/auth0-acul-js/mfa-email-challenge'; +import MfaEmailList from '@auth0/auth0-acul-js/mfa-email-list'; +``` + +
+ +## Where can I see errors related to my screen and how to handle them + +The SDK provides multiple ways to detect and view errors during the process: + +1. **`getErrors` method for screen specofic error** + A top-level getter function, `getErrors`, can be used to retrieve detailed authentication errors when backend validation fails. + ```javascript + import Login from "@auth0/auth0-acul-js/login"; + + const loginIdManager = new Login(); + + const errors = loginIdManager.getErrors(); + if (errors) { + console.error("Login failed:", errors); + } + ``` +1. **Screen-Specific Errors** + Each screen includes a `transaction.errors` property, which returns a list of errors specific to that screen. These errors are generated after the final validation of the request, helping you identify issues that need attention. + +By using these methods, you can easily track and resolve errors throughout the SDK flow. + +## Can I Use this SDK from a CDN? + +Currently, this SDK is only available for installation via the npm registry and cannot be used directly from a CDN. + +To install the SDK, run the following command: + +```sh +npm install @auth0/auth0-acul-js +``` + +Once installed, you can import and use it in your JavaScript or TypeScript or ReactJS projects. + +## Can I Build a ReactJS Application with This SDK? + +Yes, this SDK can be easily integrated into a ReactJS application. + +Although the SDK is written in Vanilla JavaScript, it is fully compatible with all JavaScript-based frameworks, including React, Angular, Vue, and others. You can seamlessly use the SDK within your React components or hooks. \ No newline at end of file diff --git a/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/globals.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/globals.mdx new file mode 100644 index 000000000..0bcd5f046 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/js-sdk/globals.mdx @@ -0,0 +1,8 @@ +--- +title: "@auth0/auth0-acul-js v1.0.0-alpha.1" +--- + +## Namespaces + +- [Screens](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Screens) +- [Types](/docs/customize/login-pages/advanced-customizations/reference/js-sdk/Types) 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 new file mode 100644 index 000000000..869d80615 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Hooks/useAuth0Themes.mdx @@ -0,0 +1,58 @@ +--- +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/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. + +## Returns + +[`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 + + +```tsx Example +import React from 'react'; +import { useAuth0Themes } from '@auth0/auth0-acul-react'; + +const ThemedComponent: React.FC = () => { + const theme = useAuth0Themes(); + + if (!theme) { + return
No theme available
; + } + + return ( +
+

+ Styled with Auth0 Theme +

+ +

Body text color: {theme.colors.body_text}

+
+ ); +}; +``` + \ No newline at end of file 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 new file mode 100644 index 000000000..524412670 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Hooks/useCurrentScreen.mdx @@ -0,0 +1,83 @@ +--- +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/ebee146156ebee4e88d738e484964ac5977ebfb9/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, +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`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CurrentScreenOptions) \| `null` + +Current screen context data, or `null` if not available + + +```tsx Basic screen routing +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 ; + case "login-password": + return ; + case "mfa-otp-challenge": + return ; + default: + return null; + } +}; +``` + + + + +```tsx Accessing multiple properties +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 ( +
+ {organizationId &&

Organization: {organizationId}

} + {errors.map((error, i) => ( +

{error.message}

+ ))} +

Language: {locale}

+
+ ); +}; +``` + \ No newline at end of file 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 new file mode 100644 index 000000000..37c05a235 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Hooks/useErrors.mdx @@ -0,0 +1,73 @@ +--- +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/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: +- `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 + +[UseErrorOptions] = {}}/> + + +## Returns + +[`UseErrorsResult`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UseErrorsResult) + +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. +- `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: + +## Supported Screens + +- The `useErrors` hook is available on every ACUL screen. + + +```tsx Example +import { useErrors } from "@auth0/auth0-acul-react"; + +export function SignupForm() { + const { errors, hasError, dismiss, dismissAll } = useErrors(); + + return ( +
+ {hasError && ( +
+ {errors.byKind("server").map(err => ( +
+ {err.message} + +
+ ))} +
+ )} + + +
+ ); +} +``` + + + +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' +``` \ No newline at end of file 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 new file mode 100644 index 000000000..cd60fc89c --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Hooks/useLoginIdentifiers.mdx @@ -0,0 +1,36 @@ +--- +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/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. + +## Returns + +[`IdentifierType`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/type-aliases/IdentifierType)[] + +An array of [IdentifierType](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/type-aliases/IdentifierType) representing active identifiers. + +## Supported Screens + +- `login` +- `login-id` +- `reset-password-request` + + +```tsx Example +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'] +``` + \ No newline at end of file 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 new file mode 100644 index 000000000..d937e3ea2 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Hooks/useMfaPolling.mdx @@ -0,0 +1,75 @@ +--- +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/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. + +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 + +[MfaPollingOptions]}> +[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`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaPollingResult) + +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. + +## Supported Screens + +- `mfa-push-challenge-push` +- `reset-password-mfa-push-challenge-push` +- `mfa-push-enrollment-qr` + + +```tsx Example +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 ( +
+ + {isRunning && } +
+ ); +} +``` + +## Remarks + +- 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. +- 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/API-Reference/Hooks/usePasswordValidation.mdx b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Hooks/usePasswordValidation.mdx new file mode 100644 index 000000000..341f44f75 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Hooks/usePasswordValidation.mdx @@ -0,0 +1,49 @@ +--- +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/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. + +Optionally, it can send the validation results to the global error manager so that +form error components can update automatically. + +## Parameters + + +The password to validate. + + + +If `true`, validation errors are stored in the global error manager under the `password` field. Defaults to `false`. + + + +## Returns + +[`PasswordValidationResult`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PasswordValidationResult) + +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`. + +## Supported Screens + +- `signup` +- `signup-password` +- `reset-password` + + +```tsx Example + import { usePasswordValidation } from '@auth0/auth0-acul-react/signup'; + const { isValid, results} = usePasswordValidation(password, { includeInErrors: true }); + + if (!isValid) { + console.log(results); + } +``` + \ No newline at end of file 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 new file mode 100644 index 000000000..d5be25186 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Hooks/useResend.mdx @@ -0,0 +1,69 @@ +--- +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/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. + +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 + +### options? + +[UseResendOptions]}> +Optional configuration such as `timeoutSeconds` and `onTimeout`. + + +## Returns + +[`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. +- `disabled` — `true` if resending is currently blocked. +- `startResend` — call to initiate a resend immediately (if allowed). + +## 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` + + +```tsx Example +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 ( + + ); +} +``` + +## 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. \ No newline at end of file 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 new file mode 100644 index 000000000..9260ab7cc --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Hooks/useSignupIdentifiers.mdx @@ -0,0 +1,44 @@ +--- +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/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. + +## Returns + +\[\] \| [`Identifier`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/Identifier)[] + +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 + +- `signup` +- `signup-id` + + +```tsx Example +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 }, +// ] +``` + \ No newline at end of file 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 new file mode 100644 index 000000000..eadbab283 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Hooks/useUsernameValidation.mdx @@ -0,0 +1,70 @@ +--- +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/ebee146156ebee4e88d738e484964ac5977ebfb9/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 +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 + + +The username string to validate. + + + +When `true`, validation errors are stored in the global error manager under the `username` field. Defaults to `false`. + + +## Returns + +[`UsernameValidationResult`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UsernameValidationResult) + +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`. + +## Supported Screens + +- `signup` +- `signup-id` + + +```tsx Example +import { useUsernameValidation } from "@auth0/auth0-acul-react/signup"; + +export function UsernameField() { + const { isValid, errors } = useUsernameValidation(username, { includeInErrors: true }); + + return ( +
+ setUsername(e.target.value)} + aria-invalid={!isValid} + /> + + {!isValid && ( +
    + {errors.map(err => ( +
  • {err.message}
    • + ))} +
+ )} +
+ ); +} +``` + +## 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. \ 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..128ffc5f9 --- /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 + +() => BrandingMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/accept-invitation.tsx#L24) + +Hook to access branding and theme configuration. + +**Returns** + +[`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 + +**Example** + +```jsx +import { useBranding } from '@auth0/auth0-acul-react/login-id'; +function CustomTheme() { + const branding = useBranding(); +} +``` + + +() => ClientMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/accept-invitation.tsx#L25) + +Hook to access Auth0 application (client) configuration. + +**Returns** + +[`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 + +**Example** + +```jsx +import { useClient } from '@auth0/auth0-acul-react/login-id'; +function AppInfo() { + const client = useClient(); +} +``` + + +() => OrganizationMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/accept-invitation.tsx#L26) + +Hook to access organization context and settings. + +**Returns** + +[`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/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

No organization context

; + } +} +``` + + +() => PromptMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/accept-invitation.tsx#L27) + +Hook to access prompt configuration and flow settings. + +**Returns** + +[`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 + +**Example** + +```jsx +import { usePrompt } from '@auth0/auth0-acul-react/login-id'; +function FlowInfo() { + const prompt = usePrompt(); +} +``` + + +() => ScreenMembersOnAcceptInvitation}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/accept-invitation.tsx#L28) + +Hook to access current screen information and metadata. + +**Returns** + +[`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 + +**Example** + +```jsx +import { useScreen } from '@auth0/auth0-acul-react/login-id'; +function ScreenDebug() { + const screen = useScreen(); +} +``` + + +() => TenantMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/accept-invitation.tsx#L23) + +Hook to access tenant configuration and settings. + +**Returns** + +[`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/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(); +} +``` + + +() => TransactionMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/accept-invitation.tsx#L29) + +Hook to access transaction state and authentication flow data. + +**Returns** + +[`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 + +**Example** + +```jsx +import { useTransaction } from '@auth0/auth0-acul-react/login-id'; +function TransactionInfo() { + const transaction = useTransaction(); +} +``` + + +() => UntrustedDataMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/accept-invitation.tsx#L30) + +Hook to access untrusted data from URL parameters and form submissions. + +**Returns** + +[`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 + +**Example** + +```jsx +import { useUntrustedData } from '@auth0/auth0-acul-react/login-id'; +function PrefilledForm() { + const untrustedData = useUntrustedData(); +} +``` + + +() => UserMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/accept-invitation.tsx#L22) + +Hook to access user information and profile data. + +**Returns** + +[`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 + +**Example** + +```jsx +import { useUser } from '@auth0/auth0-acul-react/login-id'; +function UserProfile() { + const user = useUser(); +} +``` + + + +## Functions + +void | Promise<void>}> +> **acceptInvitation**(`payload?`): `void` \| `Promise`\<`void`\> + +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** + +**payload?** + +[`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CustomOptions) + +**Returns** + +`void` \| `Promise`\<`void`\> + + +AcceptInvitationMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/accept-invitation.tsx#L49) + +**Returns** + +[`AcceptInvitationMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/AcceptInvitationMembers) + + + +## References + +useCurrentScreen} type='Hooks'/> + +useErrors} type='Hooks'/> + +useAuth0Themes} type='Hooks'/> + +UseErrorOptions} type='Types'/> + +UseErrorsResult} type='Types'/> + +ErrorsResult} type='Types'/> + +ErrorKind} 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..5834e51ed --- /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 + +() => BrandingMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/consent.tsx#L21) + +Hook to access branding and theme configuration. + +**Returns** + +[`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 + +**Example** + +```jsx +import { useBranding } from '@auth0/auth0-acul-react/login-id'; +function CustomTheme() { + const branding = useBranding(); +} +``` + + +() => ClientMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/consent.tsx#L22) + +Hook to access Auth0 application (client) configuration. + +**Returns** + +[`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 + +**Example** + +```jsx +import { useClient } from '@auth0/auth0-acul-react/login-id'; +function AppInfo() { + const client = useClient(); +} +``` + + +() => OrganizationMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/consent.tsx#L23) + +Hook to access organization context and settings. + +**Returns** + +[`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/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

No organization context

; + } +} +``` + + +() => PromptMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/consent.tsx#L24) + +Hook to access prompt configuration and flow settings. + +**Returns** + +[`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 + +**Example** + +```jsx +import { usePrompt } from '@auth0/auth0-acul-react/login-id'; +function FlowInfo() { + const prompt = usePrompt(); +} +``` + + +() => ScreenMembersOnConsent}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/consent.tsx#L25) + +Hook to access current screen information and metadata. + +**Returns** + +[`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 + +**Example** + +```jsx +import { useScreen } from '@auth0/auth0-acul-react/login-id'; +function ScreenDebug() { + const screen = useScreen(); +} +``` + + +() => TenantMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/consent.tsx#L20) + +Hook to access tenant configuration and settings. + +**Returns** + +[`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/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(); +} +``` + + +() => TransactionMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/consent.tsx#L26) + +Hook to access transaction state and authentication flow data. + +**Returns** + +[`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 + +**Example** + +```jsx +import { useTransaction } from '@auth0/auth0-acul-react/login-id'; +function TransactionInfo() { + const transaction = useTransaction(); +} +``` + + +() => UntrustedDataMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/consent.tsx#L27) + +Hook to access untrusted data from URL parameters and form submissions. + +**Returns** + +[`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 + +**Example** + +```jsx +import { useUntrustedData } from '@auth0/auth0-acul-react/login-id'; +function PrefilledForm() { + const untrustedData = useUntrustedData(); +} +``` + + +() => UserMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/consent.tsx#L19) + +Hook to access user information and profile data. + +**Returns** + +[`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 + +**Example** + +```jsx +import { useUser } from '@auth0/auth0-acul-react/login-id'; +function UserProfile() { + const user = useUser(); +} +``` + + + +## Functions + +void | Promise<void>}> +> **accept**(`payload?`): `void` \| `Promise`\<`void`\> + +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** + +**payload?** + +[`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CustomOptions) + +**Returns** + +`void` \| `Promise`\<`void`\> + + +void | Promise<void>}> +> **deny**(`payload?`): `void` \| `Promise`\<`void`\> + +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** + +**payload?** + +[`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CustomOptions) + +**Returns** + +`void` \| `Promise`\<`void`\> + + +ConsentMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/consent.tsx#L46) + +**Returns** + +[`ConsentMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ConsentMembers) + + + +## References + +useCurrentScreen} type='Hooks'/> + +useErrors} type='Hooks'/> + +useAuth0Themes} type='Hooks'/> + +UseErrorOptions} type='Types'/> + +UseErrorsResult} type='Types'/> + +ErrorsResult} type='Types'/> + +ErrorKind} 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..d6a7d6b70 --- /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 + +() => BrandingMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/customized-consent.tsx#L24) + +Hook to access branding and theme configuration. + +**Returns** + +[`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 + +**Example** + +```jsx +import { useBranding } from '@auth0/auth0-acul-react/login-id'; +function CustomTheme() { + const branding = useBranding(); +} +``` + + +() => ClientMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/customized-consent.tsx#L25) + +Hook to access Auth0 application (client) configuration. + +**Returns** + +[`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 + +**Example** + +```jsx +import { useClient } from '@auth0/auth0-acul-react/login-id'; +function AppInfo() { + const client = useClient(); +} +``` + + +() => OrganizationMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/customized-consent.tsx#L26) + +Hook to access organization context and settings. + +**Returns** + +[`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/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

No organization context

; + } +} +``` + + +() => PromptMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/customized-consent.tsx#L27) + +Hook to access prompt configuration and flow settings. + +**Returns** + +[`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 + +**Example** + +```jsx +import { usePrompt } from '@auth0/auth0-acul-react/login-id'; +function FlowInfo() { + const prompt = usePrompt(); +} +``` + + +() => ScreenMembersOnCustomizedConsent}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/customized-consent.tsx#L28) + +Hook to access current screen information and metadata. + +**Returns** + +[`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 + +**Example** + +```jsx +import { useScreen } from '@auth0/auth0-acul-react/login-id'; +function ScreenDebug() { + const screen = useScreen(); +} +``` + + +() => TenantMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/customized-consent.tsx#L23) + +Hook to access tenant configuration and settings. + +**Returns** + +[`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/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(); +} +``` + + +() => TransactionMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/customized-consent.tsx#L29) + +Hook to access transaction state and authentication flow data. + +**Returns** + +[`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 + +**Example** + +```jsx +import { useTransaction } from '@auth0/auth0-acul-react/login-id'; +function TransactionInfo() { + const transaction = useTransaction(); +} +``` + + +() => UntrustedDataMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/customized-consent.tsx#L30) + +Hook to access untrusted data from URL parameters and form submissions. + +**Returns** + +[`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 + +**Example** + +```jsx +import { useUntrustedData } from '@auth0/auth0-acul-react/login-id'; +function PrefilledForm() { + const untrustedData = useUntrustedData(); +} +``` + + +() => UserMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/customized-consent.tsx#L22) + +Hook to access user information and profile data. + +**Returns** + +[`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 + +**Example** + +```jsx +import { useUser } from '@auth0/auth0-acul-react/login-id'; +function UserProfile() { + const user = useUser(); +} +``` + + + +## Functions + +void | Promise<void>}> +> **accept**(`payload?`): `void` \| `Promise`\<`void`\> + +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** + +**payload?** + +[`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CustomOptions) + +**Returns** + +`void` \| `Promise`\<`void`\> + + +void | Promise<void>}> +> **deny**(`payload?`): `void` \| `Promise`\<`void`\> + +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** + +**payload?** + +[`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CustomOptions) + +**Returns** + +`void` \| `Promise`\<`void`\> + + +CustomizedConsentMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/customized-consent.tsx#L49) + +**Returns** + +[`CustomizedConsentMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CustomizedConsentMembers) + + + +## References + +useCurrentScreen} type='Hooks'/> + +useErrors} type='Hooks'/> + +useAuth0Themes} type='Hooks'/> + +UseErrorOptions} type='Types'/> + +UseErrorsResult} type='Types'/> + +ErrorsResult} type='Types'/> + +ErrorKind} 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..6b5d2069b --- /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 + +() => BrandingMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/device-code-activation-allowed.tsx#L17) + +Hook to access branding and theme configuration. + +**Returns** + +[`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 + +**Example** + +```jsx +import { useBranding } from '@auth0/auth0-acul-react/login-id'; +function CustomTheme() { + const branding = useBranding(); +} +``` + + +() => ClientMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/device-code-activation-allowed.tsx#L18) + +Hook to access Auth0 application (client) configuration. + +**Returns** + +[`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 + +**Example** + +```jsx +import { useClient } from '@auth0/auth0-acul-react/login-id'; +function AppInfo() { + const client = useClient(); +} +``` + + +() => OrganizationMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/device-code-activation-allowed.tsx#L19) + +Hook to access organization context and settings. + +**Returns** + +[`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/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

No organization context

; + } +} +``` + + +() => PromptMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/device-code-activation-allowed.tsx#L20) + +Hook to access prompt configuration and flow settings. + +**Returns** + +[`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 + +**Example** + +```jsx +import { usePrompt } from '@auth0/auth0-acul-react/login-id'; +function FlowInfo() { + const prompt = usePrompt(); +} +``` + + +() => ScreenMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/device-code-activation-allowed.tsx#L21) + +Hook to access current screen information and metadata. + +**Returns** + +[`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 + +**Example** + +```jsx +import { useScreen } from '@auth0/auth0-acul-react/login-id'; +function ScreenDebug() { + const screen = useScreen(); +} +``` + + +() => TenantMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/device-code-activation-allowed.tsx#L16) + +Hook to access tenant configuration and settings. + +**Returns** + +[`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/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(); +} +``` + + +() => TransactionMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/device-code-activation-allowed.tsx#L22) + +Hook to access transaction state and authentication flow data. + +**Returns** + +[`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 + +**Example** + +```jsx +import { useTransaction } from '@auth0/auth0-acul-react/login-id'; +function TransactionInfo() { + const transaction = useTransaction(); +} +``` + + +() => UntrustedDataMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/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`](/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 + +**Example** + +```jsx +import { useUntrustedData } from '@auth0/auth0-acul-react/login-id'; +function PrefilledForm() { + const untrustedData = useUntrustedData(); +} +``` + + +() => UserMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/device-code-activation-allowed.tsx#L15) + +Hook to access user information and profile data. + +**Returns** + +[`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 + +**Example** + +```jsx +import { useUser } from '@auth0/auth0-acul-react/login-id'; +function UserProfile() { + const user = useUser(); +} +``` + + + +## Functions + +DeviceCodeActivationAllowedMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/device-code-activation-allowed.tsx#L38) + +**Returns** + +[`DeviceCodeActivationAllowedMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/DeviceCodeActivationAllowedMembers) + + + +## References + +useCurrentScreen} type='Hooks'/> + +useErrors} type='Hooks'/> + +useAuth0Themes} type='Hooks'/> + +UseErrorOptions} type='Types'/> + +UseErrorsResult} type='Types'/> + +ErrorsResult} type='Types'/> + +ErrorKind} 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..6331fd739 --- /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 + +() => BrandingMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/device-code-activation-denied.tsx#L17) + +Hook to access branding and theme configuration. + +**Returns** + +[`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 + +**Example** + +```jsx +import { useBranding } from '@auth0/auth0-acul-react/login-id'; +function CustomTheme() { + const branding = useBranding(); +} +``` + + +() => ClientMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/device-code-activation-denied.tsx#L18) + +Hook to access Auth0 application (client) configuration. + +**Returns** + +[`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 + +**Example** + +```jsx +import { useClient } from '@auth0/auth0-acul-react/login-id'; +function AppInfo() { + const client = useClient(); +} +``` + + +() => OrganizationMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/device-code-activation-denied.tsx#L19) + +Hook to access organization context and settings. + +**Returns** + +[`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/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

No organization context

; + } +} +``` + + +() => PromptMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/device-code-activation-denied.tsx#L20) + +Hook to access prompt configuration and flow settings. + +**Returns** + +[`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 + +**Example** + +```jsx +import { usePrompt } from '@auth0/auth0-acul-react/login-id'; +function FlowInfo() { + const prompt = usePrompt(); +} +``` + + +() => ScreenMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/device-code-activation-denied.tsx#L21) + +Hook to access current screen information and metadata. + +**Returns** + +[`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 + +**Example** + +```jsx +import { useScreen } from '@auth0/auth0-acul-react/login-id'; +function ScreenDebug() { + const screen = useScreen(); +} +``` + + +() => TenantMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/device-code-activation-denied.tsx#L16) + +Hook to access tenant configuration and settings. + +**Returns** + +[`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/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(); +} +``` + + +() => TransactionMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/device-code-activation-denied.tsx#L22) + +Hook to access transaction state and authentication flow data. + +**Returns** + +[`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 + +**Example** + +```jsx +import { useTransaction } from '@auth0/auth0-acul-react/login-id'; +function TransactionInfo() { + const transaction = useTransaction(); +} +``` + + +() => UntrustedDataMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/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`](/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 + +**Example** + +```jsx +import { useUntrustedData } from '@auth0/auth0-acul-react/login-id'; +function PrefilledForm() { + const untrustedData = useUntrustedData(); +} +``` + + +() => UserMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/device-code-activation-denied.tsx#L15) + +Hook to access user information and profile data. + +**Returns** + +[`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 + +**Example** + +```jsx +import { useUser } from '@auth0/auth0-acul-react/login-id'; +function UserProfile() { + const user = useUser(); +} +``` + + + +## Functions + +DeviceCodeActivationDeniedMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/device-code-activation-denied.tsx#L38) + +**Returns** + +[`DeviceCodeActivationDeniedMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/DeviceCodeActivationDeniedMembers) + + + +## References + +useCurrentScreen} type='Hooks'/> + +useErrors} type='Hooks'/> + +useAuth0Themes} type='Hooks'/> + +UseErrorOptions} type='Types'/> + +UseErrorsResult} type='Types'/> + +ErrorsResult} type='Types'/> + +ErrorKind} 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..0cdbf80c6 --- /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 + +() => BrandingMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/device-code-activation.tsx#L24) + +Hook to access branding and theme configuration. + +**Returns** + +[`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 + +**Example** + +```jsx +import { useBranding } from '@auth0/auth0-acul-react/login-id'; +function CustomTheme() { + const branding = useBranding(); +} +``` + + +() => ClientMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/device-code-activation.tsx#L25) + +Hook to access Auth0 application (client) configuration. + +**Returns** + +[`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 + +**Example** + +```jsx +import { useClient } from '@auth0/auth0-acul-react/login-id'; +function AppInfo() { + const client = useClient(); +} +``` + + +() => OrganizationMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/device-code-activation.tsx#L26) + +Hook to access organization context and settings. + +**Returns** + +[`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/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

No organization context

; + } +} +``` + + +() => PromptMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/device-code-activation.tsx#L27) + +Hook to access prompt configuration and flow settings. + +**Returns** + +[`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 + +**Example** + +```jsx +import { usePrompt } from '@auth0/auth0-acul-react/login-id'; +function FlowInfo() { + const prompt = usePrompt(); +} +``` + + +() => ScreenMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/device-code-activation.tsx#L28) + +Hook to access current screen information and metadata. + +**Returns** + +[`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 + +**Example** + +```jsx +import { useScreen } from '@auth0/auth0-acul-react/login-id'; +function ScreenDebug() { + const screen = useScreen(); +} +``` + + +() => TenantMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/device-code-activation.tsx#L23) + +Hook to access tenant configuration and settings. + +**Returns** + +[`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/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(); +} +``` + + +() => TransactionMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/device-code-activation.tsx#L29) + +Hook to access transaction state and authentication flow data. + +**Returns** + +[`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 + +**Example** + +```jsx +import { useTransaction } from '@auth0/auth0-acul-react/login-id'; +function TransactionInfo() { + const transaction = useTransaction(); +} +``` + + +() => UntrustedDataMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/device-code-activation.tsx#L30) + +Hook to access untrusted data from URL parameters and form submissions. + +**Returns** + +[`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 + +**Example** + +```jsx +import { useUntrustedData } from '@auth0/auth0-acul-react/login-id'; +function PrefilledForm() { + const untrustedData = useUntrustedData(); +} +``` + + +() => UserMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/device-code-activation.tsx#L22) + +Hook to access user information and profile data. + +**Returns** + +[`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 + +**Example** + +```jsx +import { useUser } from '@auth0/auth0-acul-react/login-id'; +function UserProfile() { + const user = useUser(); +} +``` + + + +## Functions + +void | Promise<void>}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/device-code-activation.tsx#L34) + +**Parameters** + +**payload** + +[`DeviceCodeActivationContinueOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/DeviceCodeActivationContinueOptions) + +**Returns** + +`void` \| `Promise`\<`void`\> + + +DeviceCodeActivationMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/device-code-activation.tsx#L48) + +**Returns** + +[`DeviceCodeActivationMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/DeviceCodeActivationMembers) + + + +## References + +useCurrentScreen} type='Hooks'/> + +useErrors} type='Hooks'/> + +useAuth0Themes} type='Hooks'/> + +UseErrorOptions} type='Types'/> + +UseErrorsResult} type='Types'/> + +ErrorsResult} type='Types'/> + +ErrorKind} 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..08ec84866 --- /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 + +() => BrandingMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/device-code-confirmation.tsx#L24) + +Hook to access branding and theme configuration. + +**Returns** + +[`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 + +**Example** + +```jsx +import { useBranding } from '@auth0/auth0-acul-react/login-id'; +function CustomTheme() { + const branding = useBranding(); +} +``` + + +() => ClientMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/device-code-confirmation.tsx#L25) + +Hook to access Auth0 application (client) configuration. + +**Returns** + +[`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 + +**Example** + +```jsx +import { useClient } from '@auth0/auth0-acul-react/login-id'; +function AppInfo() { + const client = useClient(); +} +``` + + +() => OrganizationMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/device-code-confirmation.tsx#L26) + +Hook to access organization context and settings. + +**Returns** + +[`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/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

No organization context

; + } +} +``` + + +() => PromptMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/device-code-confirmation.tsx#L27) + +Hook to access prompt configuration and flow settings. + +**Returns** + +[`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 + +**Example** + +```jsx +import { usePrompt } from '@auth0/auth0-acul-react/login-id'; +function FlowInfo() { + const prompt = usePrompt(); +} +``` + + +() => ScreenMembersOnDeviceCodeConfirmation}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/device-code-confirmation.tsx#L28) + +Hook to access current screen information and metadata. + +**Returns** + +[`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 + +**Example** + +```jsx +import { useScreen } from '@auth0/auth0-acul-react/login-id'; +function ScreenDebug() { + const screen = useScreen(); +} +``` + + +() => TenantMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/device-code-confirmation.tsx#L23) + +Hook to access tenant configuration and settings. + +**Returns** + +[`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/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(); +} +``` + + +() => TransactionMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/device-code-confirmation.tsx#L29) + +Hook to access transaction state and authentication flow data. + +**Returns** + +[`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 + +**Example** + +```jsx +import { useTransaction } from '@auth0/auth0-acul-react/login-id'; +function TransactionInfo() { + const transaction = useTransaction(); +} +``` + + +() => UntrustedDataMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/device-code-confirmation.tsx#L30) + +Hook to access untrusted data from URL parameters and form submissions. + +**Returns** + +[`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 + +**Example** + +```jsx +import { useUntrustedData } from '@auth0/auth0-acul-react/login-id'; +function PrefilledForm() { + const untrustedData = useUntrustedData(); +} +``` + + +() => UserMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/device-code-confirmation.tsx#L22) + +Hook to access user information and profile data. + +**Returns** + +[`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 + +**Example** + +```jsx +import { useUser } from '@auth0/auth0-acul-react/login-id'; +function UserProfile() { + const user = useUser(); +} +``` + + + +## Functions + +void | Promise<void>}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/device-code-confirmation.tsx#L35) + +**Parameters** + +**payload?** + +[`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CustomOptions) + +**Returns** + +`void` \| `Promise`\<`void`\> + + +void | Promise<void>}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/device-code-confirmation.tsx#L34) + +**Parameters** + +**payload?** + +[`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CustomOptions) + +**Returns** + +`void` \| `Promise`\<`void`\> + + +DeviceCodeConfirmationMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/device-code-confirmation.tsx#L49) + +**Returns** + +[`DeviceCodeConfirmationMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/DeviceCodeConfirmationMembers) + + + +## References + +useCurrentScreen} type='Hooks'/> + +useErrors} type='Hooks'/> + +useAuth0Themes} type='Hooks'/> + +UseErrorOptions} type='Types'/> + +UseErrorsResult} type='Types'/> + +ErrorsResult} type='Types'/> + +ErrorKind} 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..f5f1857d6 --- /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 + +() => BrandingMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/email-identifier-challenge.tsx#L25) + +Hook to access branding and theme configuration. + +**Returns** + +[`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 + +**Example** + +```jsx +import { useBranding } from '@auth0/auth0-acul-react/login-id'; +function CustomTheme() { + const branding = useBranding(); +} +``` + + +() => ClientMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/email-identifier-challenge.tsx#L26) + +Hook to access Auth0 application (client) configuration. + +**Returns** + +[`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 + +**Example** + +```jsx +import { useClient } from '@auth0/auth0-acul-react/login-id'; +function AppInfo() { + const client = useClient(); +} +``` + + +() => OrganizationMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/email-identifier-challenge.tsx#L27) + +Hook to access organization context and settings. + +**Returns** + +[`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/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

No organization context

; + } +} +``` + + +() => PromptMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/email-identifier-challenge.tsx#L28) + +Hook to access prompt configuration and flow settings. + +**Returns** + +[`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 + +**Example** + +```jsx +import { usePrompt } from '@auth0/auth0-acul-react/login-id'; +function FlowInfo() { + const prompt = usePrompt(); +} +``` + + +() => ScreenMembersOnEmailIdentifierChallenge}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/email-identifier-challenge.tsx#L29) + +Hook to access current screen information and metadata. + +**Returns** + +[`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 + +**Example** + +```jsx +import { useScreen } from '@auth0/auth0-acul-react/login-id'; +function ScreenDebug() { + const screen = useScreen(); +} +``` + + +() => TenantMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/email-identifier-challenge.tsx#L24) + +Hook to access tenant configuration and settings. + +**Returns** + +[`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/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(); +} +``` + + +() => TransactionMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/email-identifier-challenge.tsx#L30) + +Hook to access transaction state and authentication flow data. + +**Returns** + +[`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 + +**Example** + +```jsx +import { useTransaction } from '@auth0/auth0-acul-react/login-id'; +function TransactionInfo() { + const transaction = useTransaction(); +} +``` + + +() => UntrustedDataMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/email-identifier-challenge.tsx#L31) + +Hook to access untrusted data from URL parameters and form submissions. + +**Returns** + +[`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 + +**Example** + +```jsx +import { useUntrustedData } from '@auth0/auth0-acul-react/login-id'; +function PrefilledForm() { + const untrustedData = useUntrustedData(); +} +``` + + +() => UserMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/email-identifier-challenge.tsx#L23) + +Hook to access user information and profile data. + +**Returns** + +[`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 + +**Example** + +```jsx +import { useUser } from '@auth0/auth0-acul-react/login-id'; +function UserProfile() { + const user = useUser(); +} +``` + + + +## Functions + +void | Promise<void>}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/email-identifier-challenge.tsx#L37) + +**Parameters** + +**payload?** + +[`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CustomOptions) + +**Returns** + +`void` \| `Promise`\<`void`\> + + +void | Promise<void>}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/email-identifier-challenge.tsx#L38) + +**Parameters** + +**payload?** + +[`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CustomOptions) + +**Returns** + +`void` \| `Promise`\<`void`\> + + +void | Promise<void>}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/email-identifier-challenge.tsx#L35) + +**Parameters** + +**payload** + +[`EmailChallengeOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/EmailChallengeOptions) + +**Returns** + +`void` \| `Promise`\<`void`\> + + +EmailIdentifierChallengeMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/email-identifier-challenge.tsx#L56) + +**Returns** + +[`EmailIdentifierChallengeMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/EmailIdentifierChallengeMembers) + + + +## References + +useResend} type='Hooks'/> + +useCurrentScreen} type='Hooks'/> + +useErrors} type='Hooks'/> + +useAuth0Themes} type='Hooks'/> + +UseErrorOptions} type='Types'/> + +UseErrorsResult} type='Types'/> + +ErrorsResult} type='Types'/> + +ErrorKind} 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..8ee5c83c6 --- /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 + +() => BrandingMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/email-otp-challenge.tsx#L25) + +Hook to access branding and theme configuration. + +**Returns** + +[`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 + +**Example** + +```jsx +import { useBranding } from '@auth0/auth0-acul-react/login-id'; +function CustomTheme() { + const branding = useBranding(); +} +``` + + +() => ClientMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/email-otp-challenge.tsx#L26) + +Hook to access Auth0 application (client) configuration. + +**Returns** + +[`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 + +**Example** + +```jsx +import { useClient } from '@auth0/auth0-acul-react/login-id'; +function AppInfo() { + const client = useClient(); +} +``` + + +() => OrganizationMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/email-otp-challenge.tsx#L27) + +Hook to access organization context and settings. + +**Returns** + +[`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/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

No organization context

; + } +} +``` + + +() => PromptMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/email-otp-challenge.tsx#L28) + +Hook to access prompt configuration and flow settings. + +**Returns** + +[`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 + +**Example** + +```jsx +import { usePrompt } from '@auth0/auth0-acul-react/login-id'; +function FlowInfo() { + const prompt = usePrompt(); +} +``` + + +() => ScreenMembersOnEmailOTPChallenge}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/email-otp-challenge.tsx#L29) + +Hook to access current screen information and metadata. + +**Returns** + +[`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 + +**Example** + +```jsx +import { useScreen } from '@auth0/auth0-acul-react/login-id'; +function ScreenDebug() { + const screen = useScreen(); +} +``` + + +() => TenantMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/email-otp-challenge.tsx#L24) + +Hook to access tenant configuration and settings. + +**Returns** + +[`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/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(); +} +``` + + +() => TransactionMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/email-otp-challenge.tsx#L30) + +Hook to access transaction state and authentication flow data. + +**Returns** + +[`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 + +**Example** + +```jsx +import { useTransaction } from '@auth0/auth0-acul-react/login-id'; +function TransactionInfo() { + const transaction = useTransaction(); +} +``` + + +() => UntrustedDataMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/email-otp-challenge.tsx#L31) + +Hook to access untrusted data from URL parameters and form submissions. + +**Returns** + +[`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 + +**Example** + +```jsx +import { useUntrustedData } from '@auth0/auth0-acul-react/login-id'; +function PrefilledForm() { + const untrustedData = useUntrustedData(); +} +``` + + +() => UserMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/email-otp-challenge.tsx#L23) + +Hook to access user information and profile data. + +**Returns** + +[`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 + +**Example** + +```jsx +import { useUser } from '@auth0/auth0-acul-react/login-id'; +function UserProfile() { + const user = useUser(); +} +``` + + + +## Functions + +void | Promise<void>}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/email-otp-challenge.tsx#L36) + +**Parameters** + +**options?** + +[`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CustomOptions) + +**Returns** + +`void` \| `Promise`\<`void`\> + + +void | Promise<void>}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/email-otp-challenge.tsx#L35) + +**Parameters** + +**options** + +[`OtpCodeOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OtpCodeOptions) + +**Returns** + +`void` \| `Promise`\<`void`\> + + +EmailOTPChallengeMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/email-otp-challenge.tsx#L53) + +**Returns** + +[`EmailOTPChallengeMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/EmailOTPChallengeMembers) + + + +## References + +useResend} type='Hooks'/> + +useCurrentScreen} type='Hooks'/> + +useErrors} type='Hooks'/> + +useAuth0Themes} type='Hooks'/> + +UseErrorOptions} type='Types'/> + +UseErrorsResult} type='Types'/> + +ErrorsResult} type='Types'/> + +ErrorKind} 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..4c9312184 --- /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 + +() => BrandingMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/email-verification-result.tsx#L17) + +Hook to access branding and theme configuration. + +**Returns** + +[`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 + +**Example** + +```jsx +import { useBranding } from '@auth0/auth0-acul-react/login-id'; +function CustomTheme() { + const branding = useBranding(); +} +``` + + +() => ClientMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/email-verification-result.tsx#L18) + +Hook to access Auth0 application (client) configuration. + +**Returns** + +[`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 + +**Example** + +```jsx +import { useClient } from '@auth0/auth0-acul-react/login-id'; +function AppInfo() { + const client = useClient(); +} +``` + + +() => OrganizationMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/email-verification-result.tsx#L19) + +Hook to access organization context and settings. + +**Returns** + +[`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/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

No organization context

; + } +} +``` + + +() => PromptMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/email-verification-result.tsx#L20) + +Hook to access prompt configuration and flow settings. + +**Returns** + +[`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 + +**Example** + +```jsx +import { usePrompt } from '@auth0/auth0-acul-react/login-id'; +function FlowInfo() { + const prompt = usePrompt(); +} +``` + + +() => ScreenMembersOnEmailVerificationResult}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/email-verification-result.tsx#L21) + +Hook to access current screen information and metadata. + +**Returns** + +[`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 + +**Example** + +```jsx +import { useScreen } from '@auth0/auth0-acul-react/login-id'; +function ScreenDebug() { + const screen = useScreen(); +} +``` + + +() => TenantMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/email-verification-result.tsx#L16) + +Hook to access tenant configuration and settings. + +**Returns** + +[`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/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(); +} +``` + + +() => TransactionMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/email-verification-result.tsx#L22) + +Hook to access transaction state and authentication flow data. + +**Returns** + +[`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 + +**Example** + +```jsx +import { useTransaction } from '@auth0/auth0-acul-react/login-id'; +function TransactionInfo() { + const transaction = useTransaction(); +} +``` + + +() => UntrustedDataMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/email-verification-result.tsx#L23) + +Hook to access untrusted data from URL parameters and form submissions. + +**Returns** + +[`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 + +**Example** + +```jsx +import { useUntrustedData } from '@auth0/auth0-acul-react/login-id'; +function PrefilledForm() { + const untrustedData = useUntrustedData(); +} +``` + + +() => UserMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/email-verification-result.tsx#L15) + +Hook to access user information and profile data. + +**Returns** + +[`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 + +**Example** + +```jsx +import { useUser } from '@auth0/auth0-acul-react/login-id'; +function UserProfile() { + const user = useUser(); +} +``` + + + +## Functions + +EmailVerificationResultMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/email-verification-result.tsx#L38) + +**Returns** + +[`EmailVerificationResultMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/EmailVerificationResultMembers) + + + +## References + +useCurrentScreen} type='Hooks'/> + +useErrors} type='Hooks'/> + +useAuth0Themes} type='Hooks'/> + +UseErrorOptions} type='Types'/> + +UseErrorsResult} type='Types'/> + +ErrorsResult} type='Types'/> + +ErrorKind} 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 new file mode 100644 index 000000000..adbb0cf0d --- /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 + +() => BrandingMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/interstitial-captcha.tsx#L17) + +Hook to access branding and theme configuration. + +**Returns** + +[`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 + +**Example** + +```jsx +import { useBranding } from '@auth0/auth0-acul-react/login-id'; +function CustomTheme() { + const branding = useBranding(); +} +``` + + +() => ClientMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/interstitial-captcha.tsx#L18) + +Hook to access Auth0 application (client) configuration. + +**Returns** + +[`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 + +**Example** + +```jsx +import { useClient } from '@auth0/auth0-acul-react/login-id'; +function AppInfo() { + const client = useClient(); +} +``` + + +() => OrganizationMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/interstitial-captcha.tsx#L19) + +Hook to access organization context and settings. + +**Returns** + +[`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/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

No organization context

; + } +} +``` + + +() => PromptMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/interstitial-captcha.tsx#L20) + +Hook to access prompt configuration and flow settings. + +**Returns** + +[`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 + +**Example** + +```jsx +import { usePrompt } from '@auth0/auth0-acul-react/login-id'; +function FlowInfo() { + const prompt = usePrompt(); +} +``` + + +() => ScreenMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/interstitial-captcha.tsx#L21) + +Hook to access current screen information and metadata. + +**Returns** + +[`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 + +**Example** + +```jsx +import { useScreen } from '@auth0/auth0-acul-react/login-id'; +function ScreenDebug() { + const screen = useScreen(); +} +``` + + +() => TenantMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/interstitial-captcha.tsx#L16) + +Hook to access tenant configuration and settings. + +**Returns** + +[`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/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(); +} +``` + + +() => TransactionMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/interstitial-captcha.tsx#L22) + +Hook to access transaction state and authentication flow data. + +**Returns** + +[`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 + +**Example** + +```jsx +import { useTransaction } from '@auth0/auth0-acul-react/login-id'; +function TransactionInfo() { + const transaction = useTransaction(); +} +``` + + +() => UntrustedDataMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/interstitial-captcha.tsx#L23) + +Hook to access untrusted data from URL parameters and form submissions. + +**Returns** + +[`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 + +**Example** + +```jsx +import { useUntrustedData } from '@auth0/auth0-acul-react/login-id'; +function PrefilledForm() { + const untrustedData = useUntrustedData(); +} +``` + + +() => UserMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/interstitial-captcha.tsx#L15) + +Hook to access user information and profile data. + +**Returns** + +[`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 + +**Example** + +```jsx +import { useUser } from '@auth0/auth0-acul-react/login-id'; +function UserProfile() { + const user = useUser(); +} +``` + + + +## Functions + +InterstitialCaptchaMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/interstitial-captcha.tsx#L38) + +**Returns** + +[`InterstitialCaptchaMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/InterstitialCaptchaMembers) + + + +## References + +useCurrentScreen} type='Hooks'/> + +useErrors} type='Hooks'/> + +useAuth0Themes} type='Hooks'/> + +UseErrorOptions} type='Types'/> + +UseErrorsResult} type='Types'/> + +ErrorsResult} type='Types'/> + +ErrorKind} 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..b5decc8c9 --- /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 + +() => BrandingMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/login-email-verification.tsx#L25) + +Hook to access branding and theme configuration. + +**Returns** + +[`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 + +**Example** + +```jsx +import { useBranding } from '@auth0/auth0-acul-react/login-id'; +function CustomTheme() { + const branding = useBranding(); +} +``` + + +() => ClientMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/login-email-verification.tsx#L26) + +Hook to access Auth0 application (client) configuration. + +**Returns** + +[`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 + +**Example** + +```jsx +import { useClient } from '@auth0/auth0-acul-react/login-id'; +function AppInfo() { + const client = useClient(); +} +``` + + +() => OrganizationMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/login-email-verification.tsx#L27) + +Hook to access organization context and settings. + +**Returns** + +[`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/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

No organization context

; + } +} +``` + + +() => PromptMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/login-email-verification.tsx#L28) + +Hook to access prompt configuration and flow settings. + +**Returns** + +[`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 + +**Example** + +```jsx +import { usePrompt } from '@auth0/auth0-acul-react/login-id'; +function FlowInfo() { + const prompt = usePrompt(); +} +``` + + +() => ScreenMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/login-email-verification.tsx#L29) + +Hook to access current screen information and metadata. + +**Returns** + +[`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 + +**Example** + +```jsx +import { useScreen } from '@auth0/auth0-acul-react/login-id'; +function ScreenDebug() { + const screen = useScreen(); +} +``` + + +() => TenantMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/login-email-verification.tsx#L24) + +Hook to access tenant configuration and settings. + +**Returns** + +[`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/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(); +} +``` + + +() => TransactionMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/login-email-verification.tsx#L30) + +Hook to access transaction state and authentication flow data. + +**Returns** + +[`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 + +**Example** + +```jsx +import { useTransaction } from '@auth0/auth0-acul-react/login-id'; +function TransactionInfo() { + const transaction = useTransaction(); +} +``` + + +() => UntrustedDataMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/login-email-verification.tsx#L31) + +Hook to access untrusted data from URL parameters and form submissions. + +**Returns** + +[`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 + +**Example** + +```jsx +import { useUntrustedData } from '@auth0/auth0-acul-react/login-id'; +function PrefilledForm() { + const untrustedData = useUntrustedData(); +} +``` + + +() => UserMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/login-email-verification.tsx#L23) + +Hook to access user information and profile data. + +**Returns** + +[`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 + +**Example** + +```jsx +import { useUser } from '@auth0/auth0-acul-react/login-id'; +function UserProfile() { + const user = useUser(); +} +``` + + + +## Functions + +void | Promise<void>}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/login-email-verification.tsx#L35) + +**Parameters** + +**payload** + +[`ContinueWithCodeOptionPayload`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ContinueWithCodeOptionPayload) + +**Returns** + +`void` \| `Promise`\<`void`\> + + +void | Promise<void>}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/login-email-verification.tsx#L37) + +**Parameters** + +**payload?** + +[`ResendCodeOptionsPayload`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResendCodeOptionsPayload) + +**Returns** + +`void` \| `Promise`\<`void`\> + + +LoginEmailVerificationMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/login-email-verification.tsx#L54) + +**Returns** + +[`LoginEmailVerificationMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/LoginEmailVerificationMembers) + + + +## References + +useResend} type='Hooks'/> + +useCurrentScreen} type='Hooks'/> + +useErrors} type='Hooks'/> + +useAuth0Themes} type='Hooks'/> + +UseErrorOptions} type='Types'/> + +UseErrorsResult} type='Types'/> + +ErrorsResult} type='Types'/> + +ErrorKind} 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..869fa21da --- /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 + +() => BrandingMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/login-id.tsx#L26) + +Hook to access branding and theme configuration. + +**Returns** + +[`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 + +**Example** + +```jsx +import { useBranding } from '@auth0/auth0-acul-react/login-id'; +function CustomTheme() { + const branding = useBranding(); +} +``` + + +() => ClientMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/login-id.tsx#L27) + +Hook to access Auth0 application (client) configuration. + +**Returns** + +[`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 + +**Example** + +```jsx +import { useClient } from '@auth0/auth0-acul-react/login-id'; +function AppInfo() { + const client = useClient(); +} +``` + + +() => OrganizationMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/login-id.tsx#L28) + +Hook to access organization context and settings. + +**Returns** + +[`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/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

No organization context

; + } +} +``` + + +() => PromptMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/login-id.tsx#L29) + +Hook to access prompt configuration and flow settings. + +**Returns** + +[`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 + +**Example** + +```jsx +import { usePrompt } from '@auth0/auth0-acul-react/login-id'; +function FlowInfo() { + const prompt = usePrompt(); +} +``` + + +() => ScreenMembersOnLoginId}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/login-id.tsx#L30) + +Hook to access current screen information and metadata. + +**Returns** + +[`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 + +**Example** + +```jsx +import { useScreen } from '@auth0/auth0-acul-react/login-id'; +function ScreenDebug() { + const screen = useScreen(); +} +``` + + +() => TenantMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/login-id.tsx#L25) + +Hook to access tenant configuration and settings. + +**Returns** + +[`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/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(); +} +``` + + +() => TransactionMembersOnLoginId}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/login-id.tsx#L31) + +Hook to access transaction state and authentication flow data. + +**Returns** + +[`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 + +**Example** + +```jsx +import { useTransaction } from '@auth0/auth0-acul-react/login-id'; +function TransactionInfo() { + const transaction = useTransaction(); +} +``` + + +() => UntrustedDataMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/login-id.tsx#L32) + +Hook to access untrusted data from URL parameters and form submissions. + +**Returns** + +[`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 + +**Example** + +```jsx +import { useUntrustedData } from '@auth0/auth0-acul-react/login-id'; +function PrefilledForm() { + const untrustedData = useUntrustedData(); +} +``` + + +() => UserMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/login-id.tsx#L24) + +Hook to access user information and profile data. + +**Returns** + +[`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 + +**Example** + +```jsx +import { useUser } from '@auth0/auth0-acul-react/login-id'; +function UserProfile() { + const user = useUser(); +} +``` + + + +## Functions + +void | Promise<void>}> +> **federatedLogin**(`payload`): `void` \| `Promise`\<`void`\> + +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** + +**payload** + +[`FederatedLoginOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/FederatedLoginOptions) + +**Returns** + +`void` \| `Promise`\<`void`\> + + +void | Promise<void>}> +> **login**(`payload`): `void` \| `Promise`\<`void`\> + +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** + +**payload** + +[`LoginOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/LoginOptions) + +**Returns** + +`void` \| `Promise`\<`void`\> + + +void | Promise<void>}> +> **passkeyLogin**(`payload?`): `void` \| `Promise`\<`void`\> + +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** + +**payload?** + +[`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CustomOptions) + +**Returns** + +`void` \| `Promise`\<`void`\> + + +void | Promise<void>}> +> **pickCountryCode**(`payload?`): `void` \| `Promise`\<`void`\> + +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** + +**payload?** + +[`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CustomOptions) + +**Returns** + +`void` \| `Promise`\<`void`\> + + +LoginIdMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/login-id.tsx#L58) + +**Returns** + +[`LoginIdMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/LoginIdMembers) + + + +## References + +useLoginIdentifiers} type='Hooks'/> + +useCurrentScreen} type='Hooks'/> + +useErrors} type='Hooks'/> + +useAuth0Themes} type='Hooks'/> + +UseErrorOptions} type='Types'/> + +UseErrorsResult} type='Types'/> + +ErrorsResult} type='Types'/> + +ErrorKind} 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..6e5babda1 --- /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 + +() => BrandingMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/login-password.tsx#L25) + +Hook to access branding and theme configuration. + +**Returns** + +[`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 + +**Example** + +```jsx +import { useBranding } from '@auth0/auth0-acul-react/login-id'; +function CustomTheme() { + const branding = useBranding(); +} +``` + + +() => ClientMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/login-password.tsx#L26) + +Hook to access Auth0 application (client) configuration. + +**Returns** + +[`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 + +**Example** + +```jsx +import { useClient } from '@auth0/auth0-acul-react/login-id'; +function AppInfo() { + const client = useClient(); +} +``` + + +() => OrganizationMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/login-password.tsx#L27) + +Hook to access organization context and settings. + +**Returns** + +[`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/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

No organization context

; + } +} +``` + + +() => PromptMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/login-password.tsx#L28) + +Hook to access prompt configuration and flow settings. + +**Returns** + +[`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 + +**Example** + +```jsx +import { usePrompt } from '@auth0/auth0-acul-react/login-id'; +function FlowInfo() { + const prompt = usePrompt(); +} +``` + + +() => ScreenMembersOnLoginPassword}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/login-password.tsx#L29) + +Hook to access current screen information and metadata. + +**Returns** + +[`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 + +**Example** + +```jsx +import { useScreen } from '@auth0/auth0-acul-react/login-id'; +function ScreenDebug() { + const screen = useScreen(); +} +``` + + +() => TenantMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/login-password.tsx#L24) + +Hook to access tenant configuration and settings. + +**Returns** + +[`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/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(); +} +``` + + +() => TransactionMembersOnLoginPassword}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/login-password.tsx#L30) + +Hook to access transaction state and authentication flow data. + +**Returns** + +[`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 + +**Example** + +```jsx +import { useTransaction } from '@auth0/auth0-acul-react/login-id'; +function TransactionInfo() { + const transaction = useTransaction(); +} +``` + + +() => UntrustedDataMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/login-password.tsx#L31) + +Hook to access untrusted data from URL parameters and form submissions. + +**Returns** + +[`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 + +**Example** + +```jsx +import { useUntrustedData } from '@auth0/auth0-acul-react/login-id'; +function PrefilledForm() { + const untrustedData = useUntrustedData(); +} +``` + + +() => UserMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/login-password.tsx#L23) + +Hook to access user information and profile data. + +**Returns** + +[`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 + +**Example** + +```jsx +import { useUser } from '@auth0/auth0-acul-react/login-id'; +function UserProfile() { + const user = useUser(); +} +``` + + + +## Functions + +void | Promise<void>}> +> **federatedLogin**(`payload`): `void` \| `Promise`\<`void`\> + +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** + +**payload** + +[`FederatedLoginPasswordOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/FederatedLoginPasswordOptions) + +**Returns** + +`void` \| `Promise`\<`void`\> + + +void | Promise<void>}> +> **login**(`payload`): `void` \| `Promise`\<`void`\> + +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** + +**payload** + +[`LoginPasswordOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/LoginPasswordOptions) + +**Returns** + +`void` \| `Promise`\<`void`\> + + +LoginPasswordMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/login-password.tsx#L51) + +**Returns** + +[`LoginPasswordMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/LoginPasswordMembers) + + + +## References + +useCurrentScreen} type='Hooks'/> + +useErrors} type='Hooks'/> + +useAuth0Themes} type='Hooks'/> + +UseErrorOptions} type='Types'/> + +UseErrorsResult} type='Types'/> + +ErrorsResult} type='Types'/> + +ErrorKind} 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..a53b126a0 --- /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 + +() => BrandingMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/login-passwordless-email-code.tsx#L25) + +Hook to access branding and theme configuration. + +**Returns** + +[`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 + +**Example** + +```jsx +import { useBranding } from '@auth0/auth0-acul-react/login-id'; +function CustomTheme() { + const branding = useBranding(); +} +``` + + +() => ClientMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/login-passwordless-email-code.tsx#L26) + +Hook to access Auth0 application (client) configuration. + +**Returns** + +[`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 + +**Example** + +```jsx +import { useClient } from '@auth0/auth0-acul-react/login-id'; +function AppInfo() { + const client = useClient(); +} +``` + + +() => OrganizationMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/login-passwordless-email-code.tsx#L27) + +Hook to access organization context and settings. + +**Returns** + +[`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/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

No organization context

; + } +} +``` + + +() => PromptMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/login-passwordless-email-code.tsx#L28) + +Hook to access prompt configuration and flow settings. + +**Returns** + +[`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 + +**Example** + +```jsx +import { usePrompt } from '@auth0/auth0-acul-react/login-id'; +function FlowInfo() { + const prompt = usePrompt(); +} +``` + + +() => ScreenMembersOnLoginPasswordlessEmailCode}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/login-passwordless-email-code.tsx#L29) + +Hook to access current screen information and metadata. + +**Returns** + +[`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 + +**Example** + +```jsx +import { useScreen } from '@auth0/auth0-acul-react/login-id'; +function ScreenDebug() { + const screen = useScreen(); +} +``` + + +() => TenantMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/login-passwordless-email-code.tsx#L24) + +Hook to access tenant configuration and settings. + +**Returns** + +[`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/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(); +} +``` + + +() => TransactionMembersOnLoginPasswordlessEmailCode}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/login-passwordless-email-code.tsx#L30) + +Hook to access transaction state and authentication flow data. + +**Returns** + +[`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 + +**Example** + +```jsx +import { useTransaction } from '@auth0/auth0-acul-react/login-id'; +function TransactionInfo() { + const transaction = useTransaction(); +} +``` + + +() => UntrustedDataMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/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`](/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 + +**Example** + +```jsx +import { useUntrustedData } from '@auth0/auth0-acul-react/login-id'; +function PrefilledForm() { + const untrustedData = useUntrustedData(); +} +``` + + +() => UserMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/login-passwordless-email-code.tsx#L23) + +Hook to access user information and profile data. + +**Returns** + +[`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 + +**Example** + +```jsx +import { useUser } from '@auth0/auth0-acul-react/login-id'; +function UserProfile() { + const user = useUser(); +} +``` + + + +## Functions + +void | Promise<void>}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/login-passwordless-email-code.tsx#L36) + +**Parameters** + +**payload?** + +[`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CustomOptions) + +**Returns** + +`void` \| `Promise`\<`void`\> + + +void | Promise<void>}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/login-passwordless-email-code.tsx#L35) + +**Parameters** + +**payload** + +[`SubmitCodeOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/SubmitCodeOptions) + +**Returns** + +`void` \| `Promise`\<`void`\> + + +LoginPasswordlessEmailCodeMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/login-passwordless-email-code.tsx#L53) + +**Returns** + +[`LoginPasswordlessEmailCodeMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/LoginPasswordlessEmailCodeMembers) + + + +## References + +useResend} type='Hooks'/> + +useCurrentScreen} type='Hooks'/> + +useErrors} type='Hooks'/> + +useAuth0Themes} type='Hooks'/> + +UseErrorOptions} type='Types'/> + +UseErrorsResult} type='Types'/> + +ErrorsResult} type='Types'/> + +ErrorKind} 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..dbf82de0b --- /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 + +() => BrandingMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/login-passwordless-sms-otp.tsx#L25) + +Hook to access branding and theme configuration. + +**Returns** + +[`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 + +**Example** + +```jsx +import { useBranding } from '@auth0/auth0-acul-react/login-id'; +function CustomTheme() { + const branding = useBranding(); +} +``` + + +() => ClientMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/login-passwordless-sms-otp.tsx#L26) + +Hook to access Auth0 application (client) configuration. + +**Returns** + +[`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 + +**Example** + +```jsx +import { useClient } from '@auth0/auth0-acul-react/login-id'; +function AppInfo() { + const client = useClient(); +} +``` + + +() => OrganizationMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/login-passwordless-sms-otp.tsx#L27) + +Hook to access organization context and settings. + +**Returns** + +[`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/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

No organization context

; + } +} +``` + + +() => PromptMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/login-passwordless-sms-otp.tsx#L28) + +Hook to access prompt configuration and flow settings. + +**Returns** + +[`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 + +**Example** + +```jsx +import { usePrompt } from '@auth0/auth0-acul-react/login-id'; +function FlowInfo() { + const prompt = usePrompt(); +} +``` + + +() => ScreenMembersOnLoginPasswordlessSmsOtp}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/login-passwordless-sms-otp.tsx#L29) + +Hook to access current screen information and metadata. + +**Returns** + +[`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 + +**Example** + +```jsx +import { useScreen } from '@auth0/auth0-acul-react/login-id'; +function ScreenDebug() { + const screen = useScreen(); +} +``` + + +() => TenantMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/login-passwordless-sms-otp.tsx#L24) + +Hook to access tenant configuration and settings. + +**Returns** + +[`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/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(); +} +``` + + +() => TransactionMembersOnLoginPasswordlessSmsOtp}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/login-passwordless-sms-otp.tsx#L30) + +Hook to access transaction state and authentication flow data. + +**Returns** + +[`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 + +**Example** + +```jsx +import { useTransaction } from '@auth0/auth0-acul-react/login-id'; +function TransactionInfo() { + const transaction = useTransaction(); +} +``` + + +() => UntrustedDataMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/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`](/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 + +**Example** + +```jsx +import { useUntrustedData } from '@auth0/auth0-acul-react/login-id'; +function PrefilledForm() { + const untrustedData = useUntrustedData(); +} +``` + + +() => UserMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/login-passwordless-sms-otp.tsx#L23) + +Hook to access user information and profile data. + +**Returns** + +[`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 + +**Example** + +```jsx +import { useUser } from '@auth0/auth0-acul-react/login-id'; +function UserProfile() { + const user = useUser(); +} +``` + + + +## Functions + +void | Promise<void>}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/login-passwordless-sms-otp.tsx#L36) + +**Parameters** + +**payload?** + +[`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CustomOptions) + +**Returns** + +`void` \| `Promise`\<`void`\> + + +void | Promise<void>}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/login-passwordless-sms-otp.tsx#L35) + +**Parameters** + +**payload** + +[`SubmitOTPOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/SubmitOTPOptions) + +**Returns** + +`void` \| `Promise`\<`void`\> + + +LoginPasswordlessSmsOtpMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/login-passwordless-sms-otp.tsx#L53) + +**Returns** + +[`LoginPasswordlessSmsOtpMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/LoginPasswordlessSmsOtpMembers) + + + +## References + +useResend} type='Hooks'/> + +useCurrentScreen} type='Hooks'/> + +useErrors} type='Hooks'/> + +useAuth0Themes} type='Hooks'/> + +UseErrorOptions} type='Types'/> + +UseErrorsResult} type='Types'/> + +ErrorsResult} type='Types'/> + +ErrorKind} 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..632411fbd --- /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 + +() => BrandingMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/login.tsx#L26) + +Hook to access branding and theme configuration. + +**Returns** + +[`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 + +**Example** + +```jsx +import { useBranding } from '@auth0/auth0-acul-react/login-id'; +function CustomTheme() { + const branding = useBranding(); +} +``` + + +() => ClientMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/login.tsx#L27) + +Hook to access Auth0 application (client) configuration. + +**Returns** + +[`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 + +**Example** + +```jsx +import { useClient } from '@auth0/auth0-acul-react/login-id'; +function AppInfo() { + const client = useClient(); +} +``` + + +() => OrganizationMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/login.tsx#L28) + +Hook to access organization context and settings. + +**Returns** + +[`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/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

No organization context

; + } +} +``` + + +() => PromptMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/login.tsx#L29) + +Hook to access prompt configuration and flow settings. + +**Returns** + +[`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 + +**Example** + +```jsx +import { usePrompt } from '@auth0/auth0-acul-react/login-id'; +function FlowInfo() { + const prompt = usePrompt(); +} +``` + + +() => ScreenMembersOnLogin}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/login.tsx#L30) + +Hook to access current screen information and metadata. + +**Returns** + +[`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 + +**Example** + +```jsx +import { useScreen } from '@auth0/auth0-acul-react/login-id'; +function ScreenDebug() { + const screen = useScreen(); +} +``` + + +() => TenantMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/login.tsx#L25) + +Hook to access tenant configuration and settings. + +**Returns** + +[`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/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(); +} +``` + + +() => TransactionMembersOnLogin}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/login.tsx#L31) + +Hook to access transaction state and authentication flow data. + +**Returns** + +[`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 + +**Example** + +```jsx +import { useTransaction } from '@auth0/auth0-acul-react/login-id'; +function TransactionInfo() { + const transaction = useTransaction(); +} +``` + + +() => UntrustedDataMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/login.tsx#L32) + +Hook to access untrusted data from URL parameters and form submissions. + +**Returns** + +[`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 + +**Example** + +```jsx +import { useUntrustedData } from '@auth0/auth0-acul-react/login-id'; +function PrefilledForm() { + const untrustedData = useUntrustedData(); +} +``` + + +() => UserMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/login.tsx#L24) + +Hook to access user information and profile data. + +**Returns** + +[`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 + +**Example** + +```jsx +import { useUser } from '@auth0/auth0-acul-react/login-id'; +function UserProfile() { + const user = useUser(); +} +``` + + + +## Functions + +void | Promise<void>}> +> **federatedLogin**(`payload`): `void` \| `Promise`\<`void`\> + +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** + +**payload** + +[`FederatedLoginPayloadOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/FederatedLoginPayloadOptions) + +**Returns** + +`void` \| `Promise`\<`void`\> + + +void | Promise<void>}> +> **login**(`payload`): `void` \| `Promise`\<`void`\> + +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** + +**payload** + +[`LoginPayloadOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/LoginPayloadOptions) + +**Returns** + +`void` \| `Promise`\<`void`\> + + +void | Promise<void>}> +> **pickCountryCode**(`payload?`): `void` \| `Promise`\<`void`\> + +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** + +**payload?** + +[`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CustomOptions) + +**Returns** + +`void` \| `Promise`\<`void`\> + + +LoginMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/login.tsx#L57) + +**Returns** + +[`LoginMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/LoginMembers) + + + +## References + +useLoginIdentifiers} type='Hooks'/> + +useCurrentScreen} type='Hooks'/> + +useErrors} type='Hooks'/> + +useAuth0Themes} type='Hooks'/> + +UseErrorOptions} type='Types'/> + +UseErrorsResult} type='Types'/> + +ErrorsResult} type='Types'/> + +ErrorKind} 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..ab17282b6 --- /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 + +() => BrandingMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/logout-aborted.tsx#L17) + +Hook to access branding and theme configuration. + +**Returns** + +[`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 + +**Example** + +```jsx +import { useBranding } from '@auth0/auth0-acul-react/login-id'; +function CustomTheme() { + const branding = useBranding(); +} +``` + + +() => ClientMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/logout-aborted.tsx#L18) + +Hook to access Auth0 application (client) configuration. + +**Returns** + +[`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 + +**Example** + +```jsx +import { useClient } from '@auth0/auth0-acul-react/login-id'; +function AppInfo() { + const client = useClient(); +} +``` + + +() => OrganizationMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/logout-aborted.tsx#L19) + +Hook to access organization context and settings. + +**Returns** + +[`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/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

No organization context

; + } +} +``` + + +() => PromptMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/logout-aborted.tsx#L20) + +Hook to access prompt configuration and flow settings. + +**Returns** + +[`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 + +**Example** + +```jsx +import { usePrompt } from '@auth0/auth0-acul-react/login-id'; +function FlowInfo() { + const prompt = usePrompt(); +} +``` + + +() => ScreenMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/logout-aborted.tsx#L21) + +Hook to access current screen information and metadata. + +**Returns** + +[`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 + +**Example** + +```jsx +import { useScreen } from '@auth0/auth0-acul-react/login-id'; +function ScreenDebug() { + const screen = useScreen(); +} +``` + + +() => TenantMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/logout-aborted.tsx#L16) + +Hook to access tenant configuration and settings. + +**Returns** + +[`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/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(); +} +``` + + +() => TransactionMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/logout-aborted.tsx#L22) + +Hook to access transaction state and authentication flow data. + +**Returns** + +[`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 + +**Example** + +```jsx +import { useTransaction } from '@auth0/auth0-acul-react/login-id'; +function TransactionInfo() { + const transaction = useTransaction(); +} +``` + + +() => UntrustedDataMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/logout-aborted.tsx#L23) + +Hook to access untrusted data from URL parameters and form submissions. + +**Returns** + +[`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 + +**Example** + +```jsx +import { useUntrustedData } from '@auth0/auth0-acul-react/login-id'; +function PrefilledForm() { + const untrustedData = useUntrustedData(); +} +``` + + +() => UserMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/logout-aborted.tsx#L15) + +Hook to access user information and profile data. + +**Returns** + +[`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 + +**Example** + +```jsx +import { useUser } from '@auth0/auth0-acul-react/login-id'; +function UserProfile() { + const user = useUser(); +} +``` + + + +## Functions + +LogoutAbortedMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/logout-aborted.tsx#L38) + +**Returns** + +[`LogoutAbortedMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/LogoutAbortedMembers) + + + +## References + +useCurrentScreen} type='Hooks'/> + +useErrors} type='Hooks'/> + +useAuth0Themes} type='Hooks'/> + +UseErrorOptions} type='Types'/> + +UseErrorsResult} type='Types'/> + +ErrorsResult} type='Types'/> + +ErrorKind} 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..67de057e9 --- /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 + +() => BrandingMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/logout-complete.tsx#L17) + +Hook to access branding and theme configuration. + +**Returns** + +[`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 + +**Example** + +```jsx +import { useBranding } from '@auth0/auth0-acul-react/login-id'; +function CustomTheme() { + const branding = useBranding(); +} +``` + + +() => ClientMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/logout-complete.tsx#L18) + +Hook to access Auth0 application (client) configuration. + +**Returns** + +[`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 + +**Example** + +```jsx +import { useClient } from '@auth0/auth0-acul-react/login-id'; +function AppInfo() { + const client = useClient(); +} +``` + + +() => OrganizationMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/logout-complete.tsx#L19) + +Hook to access organization context and settings. + +**Returns** + +[`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/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

No organization context

; + } +} +``` + + +() => PromptMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/logout-complete.tsx#L20) + +Hook to access prompt configuration and flow settings. + +**Returns** + +[`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 + +**Example** + +```jsx +import { usePrompt } from '@auth0/auth0-acul-react/login-id'; +function FlowInfo() { + const prompt = usePrompt(); +} +``` + + +() => ScreenMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/logout-complete.tsx#L21) + +Hook to access current screen information and metadata. + +**Returns** + +[`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 + +**Example** + +```jsx +import { useScreen } from '@auth0/auth0-acul-react/login-id'; +function ScreenDebug() { + const screen = useScreen(); +} +``` + + +() => TenantMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/logout-complete.tsx#L16) + +Hook to access tenant configuration and settings. + +**Returns** + +[`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/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(); +} +``` + + +() => TransactionMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/logout-complete.tsx#L22) + +Hook to access transaction state and authentication flow data. + +**Returns** + +[`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 + +**Example** + +```jsx +import { useTransaction } from '@auth0/auth0-acul-react/login-id'; +function TransactionInfo() { + const transaction = useTransaction(); +} +``` + + +() => UntrustedDataMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/logout-complete.tsx#L23) + +Hook to access untrusted data from URL parameters and form submissions. + +**Returns** + +[`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 + +**Example** + +```jsx +import { useUntrustedData } from '@auth0/auth0-acul-react/login-id'; +function PrefilledForm() { + const untrustedData = useUntrustedData(); +} +``` + + +() => UserMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/logout-complete.tsx#L15) + +Hook to access user information and profile data. + +**Returns** + +[`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 + +**Example** + +```jsx +import { useUser } from '@auth0/auth0-acul-react/login-id'; +function UserProfile() { + const user = useUser(); +} +``` + + + +## Functions + +LogoutCompleteMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/logout-complete.tsx#L38) + +**Returns** + +[`LogoutCompleteMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/LogoutCompleteMembers) + + + +## References + +useCurrentScreen} type='Hooks'/> + +useErrors} type='Hooks'/> + +useAuth0Themes} type='Hooks'/> + +UseErrorOptions} type='Types'/> + +UseErrorsResult} type='Types'/> + +ErrorsResult} type='Types'/> + +ErrorKind} 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..078b68008 --- /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 + +() => BrandingMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/logout.tsx#L21) + +Hook to access branding and theme configuration. + +**Returns** + +[`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 + +**Example** + +```jsx +import { useBranding } from '@auth0/auth0-acul-react/login-id'; +function CustomTheme() { + const branding = useBranding(); +} +``` + + +() => ClientMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/logout.tsx#L22) + +Hook to access Auth0 application (client) configuration. + +**Returns** + +[`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 + +**Example** + +```jsx +import { useClient } from '@auth0/auth0-acul-react/login-id'; +function AppInfo() { + const client = useClient(); +} +``` + + +() => OrganizationMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/logout.tsx#L23) + +Hook to access organization context and settings. + +**Returns** + +[`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/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

No organization context

; + } +} +``` + + +() => PromptMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/logout.tsx#L24) + +Hook to access prompt configuration and flow settings. + +**Returns** + +[`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 + +**Example** + +```jsx +import { usePrompt } from '@auth0/auth0-acul-react/login-id'; +function FlowInfo() { + const prompt = usePrompt(); +} +``` + + +() => ScreenMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/logout.tsx#L25) + +Hook to access current screen information and metadata. + +**Returns** + +[`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 + +**Example** + +```jsx +import { useScreen } from '@auth0/auth0-acul-react/login-id'; +function ScreenDebug() { + const screen = useScreen(); +} +``` + + +() => TenantMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/logout.tsx#L20) + +Hook to access tenant configuration and settings. + +**Returns** + +[`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/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(); +} +``` + + +() => TransactionMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/logout.tsx#L26) + +Hook to access transaction state and authentication flow data. + +**Returns** + +[`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 + +**Example** + +```jsx +import { useTransaction } from '@auth0/auth0-acul-react/login-id'; +function TransactionInfo() { + const transaction = useTransaction(); +} +``` + + +() => UntrustedDataMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/logout.tsx#L27) + +Hook to access untrusted data from URL parameters and form submissions. + +**Returns** + +[`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 + +**Example** + +```jsx +import { useUntrustedData } from '@auth0/auth0-acul-react/login-id'; +function PrefilledForm() { + const untrustedData = useUntrustedData(); +} +``` + + +() => UserMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/logout.tsx#L19) + +Hook to access user information and profile data. + +**Returns** + +[`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 + +**Example** + +```jsx +import { useUser } from '@auth0/auth0-acul-react/login-id'; +function UserProfile() { + const user = useUser(); +} +``` + + + +## Functions + +void | Promise<void>}> +> **confirmLogout**(`payload`): `void` \| `Promise`\<`void`\> + +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** + +**payload** + +[`ConfirmLogoutOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ConfirmLogoutOptions) + +**Returns** + +`void` \| `Promise`\<`void`\> + + +LogoutMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/logout.tsx#L46) + +**Returns** + +[`LogoutMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/LogoutMembers) + + + +## References + +useCurrentScreen} type='Hooks'/> + +useErrors} type='Hooks'/> + +useAuth0Themes} type='Hooks'/> + +UseErrorOptions} type='Types'/> + +UseErrorsResult} type='Types'/> + +ErrorsResult} type='Types'/> + +ErrorKind} 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..a66af1d42 --- /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 + +() => BrandingMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-begin-enroll-options.tsx#L24) + +Hook to access branding and theme configuration. + +**Returns** + +[`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 + +**Example** + +```jsx +import { useBranding } from '@auth0/auth0-acul-react/login-id'; +function CustomTheme() { + const branding = useBranding(); +} +``` + + +() => ClientMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-begin-enroll-options.tsx#L25) + +Hook to access Auth0 application (client) configuration. + +**Returns** + +[`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 + +**Example** + +```jsx +import { useClient } from '@auth0/auth0-acul-react/login-id'; +function AppInfo() { + const client = useClient(); +} +``` + + +() => OrganizationMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-begin-enroll-options.tsx#L26) + +Hook to access organization context and settings. + +**Returns** + +[`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/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

No organization context

; + } +} +``` + + +() => PromptMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-begin-enroll-options.tsx#L27) + +Hook to access prompt configuration and flow settings. + +**Returns** + +[`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 + +**Example** + +```jsx +import { usePrompt } from '@auth0/auth0-acul-react/login-id'; +function FlowInfo() { + const prompt = usePrompt(); +} +``` + + +() => ScreenMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-begin-enroll-options.tsx#L28) + +Hook to access current screen information and metadata. + +**Returns** + +[`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 + +**Example** + +```jsx +import { useScreen } from '@auth0/auth0-acul-react/login-id'; +function ScreenDebug() { + const screen = useScreen(); +} +``` + + +() => TenantMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-begin-enroll-options.tsx#L23) + +Hook to access tenant configuration and settings. + +**Returns** + +[`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/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(); +} +``` + + +() => TransactionMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-begin-enroll-options.tsx#L29) + +Hook to access transaction state and authentication flow data. + +**Returns** + +[`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 + +**Example** + +```jsx +import { useTransaction } from '@auth0/auth0-acul-react/login-id'; +function TransactionInfo() { + const transaction = useTransaction(); +} +``` + + +() => UntrustedDataMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/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`](/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 + +**Example** + +```jsx +import { useUntrustedData } from '@auth0/auth0-acul-react/login-id'; +function PrefilledForm() { + const untrustedData = useUntrustedData(); +} +``` + + +() => UserMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-begin-enroll-options.tsx#L22) + +Hook to access user information and profile data. + +**Returns** + +[`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 + +**Example** + +```jsx +import { useUser } from '@auth0/auth0-acul-react/login-id'; +function UserProfile() { + const user = useUser(); +} +``` + + + +## Functions + +void | Promise<void>}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-begin-enroll-options.tsx#L34) + +**Parameters** + +**payload** + +[`MfaEnrollOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaEnrollOptions) + +**Returns** + +`void` \| `Promise`\<`void`\> + + +MfaBeginEnrollOptionsMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-begin-enroll-options.tsx#L48) + +**Returns** + +[`MfaBeginEnrollOptionsMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaBeginEnrollOptionsMembers) + + + +## References + +useCurrentScreen} type='Hooks'/> + +useErrors} type='Hooks'/> + +useAuth0Themes} type='Hooks'/> + +UseErrorOptions} type='Types'/> + +UseErrorsResult} type='Types'/> + +ErrorsResult} type='Types'/> + +ErrorKind} 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..f3c25c710 --- /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 + +() => BrandingMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-country-codes.tsx#L25) + +Hook to access branding and theme configuration. + +**Returns** + +[`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 + +**Example** + +```jsx +import { useBranding } from '@auth0/auth0-acul-react/login-id'; +function CustomTheme() { + const branding = useBranding(); +} +``` + + +() => ClientMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-country-codes.tsx#L26) + +Hook to access Auth0 application (client) configuration. + +**Returns** + +[`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 + +**Example** + +```jsx +import { useClient } from '@auth0/auth0-acul-react/login-id'; +function AppInfo() { + const client = useClient(); +} +``` + + +() => OrganizationMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-country-codes.tsx#L27) + +Hook to access organization context and settings. + +**Returns** + +[`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/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

No organization context

; + } +} +``` + + +() => PromptMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-country-codes.tsx#L28) + +Hook to access prompt configuration and flow settings. + +**Returns** + +[`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 + +**Example** + +```jsx +import { usePrompt } from '@auth0/auth0-acul-react/login-id'; +function FlowInfo() { + const prompt = usePrompt(); +} +``` + + +() => ScreenMembersOnMfaCountryCodes}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-country-codes.tsx#L29) + +Hook to access current screen information and metadata. + +**Returns** + +[`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 + +**Example** + +```jsx +import { useScreen } from '@auth0/auth0-acul-react/login-id'; +function ScreenDebug() { + const screen = useScreen(); +} +``` + + +() => TenantMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-country-codes.tsx#L24) + +Hook to access tenant configuration and settings. + +**Returns** + +[`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/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(); +} +``` + + +() => TransactionMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-country-codes.tsx#L30) + +Hook to access transaction state and authentication flow data. + +**Returns** + +[`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 + +**Example** + +```jsx +import { useTransaction } from '@auth0/auth0-acul-react/login-id'; +function TransactionInfo() { + const transaction = useTransaction(); +} +``` + + +() => UntrustedDataMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-country-codes.tsx#L31) + +Hook to access untrusted data from URL parameters and form submissions. + +**Returns** + +[`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 + +**Example** + +```jsx +import { useUntrustedData } from '@auth0/auth0-acul-react/login-id'; +function PrefilledForm() { + const untrustedData = useUntrustedData(); +} +``` + + +() => UserMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-country-codes.tsx#L23) + +Hook to access user information and profile data. + +**Returns** + +[`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 + +**Example** + +```jsx +import { useUser } from '@auth0/auth0-acul-react/login-id'; +function UserProfile() { + const user = useUser(); +} +``` + + + +## Functions + +void | Promise<void>}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-country-codes.tsx#L37) + +**Parameters** + +**payload?** + +[`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CustomOptions) + +**Returns** + +`void` \| `Promise`\<`void`\> + + +void | Promise<void>}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-country-codes.tsx#L35) + +**Parameters** + +**payload** + +[`SelectCountryCodeOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/SelectCountryCodeOptions) + +**Returns** + +`void` \| `Promise`\<`void`\> + + +MfaCountryCodesMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-country-codes.tsx#L51) + +**Returns** + +[`MfaCountryCodesMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaCountryCodesMembers) + + + +## References + +useCurrentScreen} type='Hooks'/> + +useErrors} type='Hooks'/> + +useAuth0Themes} type='Hooks'/> + +UseErrorOptions} type='Types'/> + +UseErrorsResult} type='Types'/> + +ErrorsResult} type='Types'/> + +ErrorKind} 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..1fadd8406 --- /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 + +() => BrandingMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-detect-browser-capabilities.tsx#L24) + +Hook to access branding and theme configuration. + +**Returns** + +[`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 + +**Example** + +```jsx +import { useBranding } from '@auth0/auth0-acul-react/login-id'; +function CustomTheme() { + const branding = useBranding(); +} +``` + + +() => ClientMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-detect-browser-capabilities.tsx#L25) + +Hook to access Auth0 application (client) configuration. + +**Returns** + +[`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 + +**Example** + +```jsx +import { useClient } from '@auth0/auth0-acul-react/login-id'; +function AppInfo() { + const client = useClient(); +} +``` + + +() => OrganizationMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-detect-browser-capabilities.tsx#L26) + +Hook to access organization context and settings. + +**Returns** + +[`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/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

No organization context

; + } +} +``` + + +() => PromptMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-detect-browser-capabilities.tsx#L27) + +Hook to access prompt configuration and flow settings. + +**Returns** + +[`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 + +**Example** + +```jsx +import { usePrompt } from '@auth0/auth0-acul-react/login-id'; +function FlowInfo() { + const prompt = usePrompt(); +} +``` + + +() => ScreenMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-detect-browser-capabilities.tsx#L28) + +Hook to access current screen information and metadata. + +**Returns** + +[`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 + +**Example** + +```jsx +import { useScreen } from '@auth0/auth0-acul-react/login-id'; +function ScreenDebug() { + const screen = useScreen(); +} +``` + + +() => TenantMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-detect-browser-capabilities.tsx#L23) + +Hook to access tenant configuration and settings. + +**Returns** + +[`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/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(); +} +``` + + +() => TransactionMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-detect-browser-capabilities.tsx#L29) + +Hook to access transaction state and authentication flow data. + +**Returns** + +[`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 + +**Example** + +```jsx +import { useTransaction } from '@auth0/auth0-acul-react/login-id'; +function TransactionInfo() { + const transaction = useTransaction(); +} +``` + + +() => UntrustedDataMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/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`](/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 + +**Example** + +```jsx +import { useUntrustedData } from '@auth0/auth0-acul-react/login-id'; +function PrefilledForm() { + const untrustedData = useUntrustedData(); +} +``` + + +() => UserMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-detect-browser-capabilities.tsx#L22) + +Hook to access user information and profile data. + +**Returns** + +[`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 + +**Example** + +```jsx +import { useUser } from '@auth0/auth0-acul-react/login-id'; +function UserProfile() { + const user = useUser(); +} +``` + + + +## Functions + +void | Promise<void>}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-detect-browser-capabilities.tsx#L34) + +**Parameters** + +**payload** + +[`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CustomOptions) + +**Returns** + +`void` \| `Promise`\<`void`\> + + +MfaDetectBrowserCapabilitiesMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-detect-browser-capabilities.tsx#L49) + +**Returns** + +[`MfaDetectBrowserCapabilitiesMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaDetectBrowserCapabilitiesMembers) + + + +## References + +useCurrentScreen} type='Hooks'/> + +useErrors} type='Hooks'/> + +useAuth0Themes} type='Hooks'/> + +UseErrorOptions} type='Types'/> + +UseErrorsResult} type='Types'/> + +ErrorsResult} type='Types'/> + +ErrorKind} 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..ad2733929 --- /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 + +() => BrandingMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-email-challenge.tsx#L27) + +Hook to access branding and theme configuration. + +**Returns** + +[`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 + +**Example** + +```jsx +import { useBranding } from '@auth0/auth0-acul-react/login-id'; +function CustomTheme() { + const branding = useBranding(); +} +``` + + +() => ClientMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-email-challenge.tsx#L28) + +Hook to access Auth0 application (client) configuration. + +**Returns** + +[`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 + +**Example** + +```jsx +import { useClient } from '@auth0/auth0-acul-react/login-id'; +function AppInfo() { + const client = useClient(); +} +``` + + +() => OrganizationMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-email-challenge.tsx#L29) + +Hook to access organization context and settings. + +**Returns** + +[`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/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

No organization context

; + } +} +``` + + +() => PromptMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-email-challenge.tsx#L30) + +Hook to access prompt configuration and flow settings. + +**Returns** + +[`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 + +**Example** + +```jsx +import { usePrompt } from '@auth0/auth0-acul-react/login-id'; +function FlowInfo() { + const prompt = usePrompt(); +} +``` + + +() => ScreenMembersOnMfaEmailChallenge}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-email-challenge.tsx#L31) + +Hook to access current screen information and metadata. + +**Returns** + +[`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 + +**Example** + +```jsx +import { useScreen } from '@auth0/auth0-acul-react/login-id'; +function ScreenDebug() { + const screen = useScreen(); +} +``` + + +() => TenantMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-email-challenge.tsx#L26) + +Hook to access tenant configuration and settings. + +**Returns** + +[`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/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(); +} +``` + + +() => TransactionMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-email-challenge.tsx#L32) + +Hook to access transaction state and authentication flow data. + +**Returns** + +[`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 + +**Example** + +```jsx +import { useTransaction } from '@auth0/auth0-acul-react/login-id'; +function TransactionInfo() { + const transaction = useTransaction(); +} +``` + + +() => UntrustedDataMembersOnMfaEmailChallenge}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-email-challenge.tsx#L33) + +Hook to access untrusted data from URL parameters and form submissions. + +**Returns** + +[`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 + +**Example** + +```jsx +import { useUntrustedData } from '@auth0/auth0-acul-react/login-id'; +function PrefilledForm() { + const untrustedData = useUntrustedData(); +} +``` + + +() => UserMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-email-challenge.tsx#L25) + +Hook to access user information and profile data. + +**Returns** + +[`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 + +**Example** + +```jsx +import { useUser } from '@auth0/auth0-acul-react/login-id'; +function UserProfile() { + const user = useUser(); +} +``` + + + +## Functions + +void | Promise<void>}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-email-challenge.tsx#L37) + +**Parameters** + +**payload** + +[`ContinuePayloadOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ContinuePayloadOptions) + +**Returns** + +`void` \| `Promise`\<`void`\> + + +void | Promise<void>}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-email-challenge.tsx#L41) + +**Parameters** + +**payload?** + +[`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CustomOptions) + +**Returns** + +`void` \| `Promise`\<`void`\> + + +void | Promise<void>}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-email-challenge.tsx#L38) + +**Parameters** + +**payload?** + +[`ResendCodePayloadOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResendCodePayloadOptions) + +**Returns** + +`void` \| `Promise`\<`void`\> + + +void | Promise<void>}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-email-challenge.tsx#L39) + +**Parameters** + +**payload?** + +[`TryAnotherMethodPayloadOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TryAnotherMethodPayloadOptions) + +**Returns** + +`void` \| `Promise`\<`void`\> + + +MfaEmailChallengeMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-email-challenge.tsx#L58) + +**Returns** + +[`MfaEmailChallengeMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaEmailChallengeMembers) + + + +## References + +useResend} type='Hooks'/> + +useCurrentScreen} type='Hooks'/> + +useErrors} type='Hooks'/> + +useAuth0Themes} type='Hooks'/> + +UseErrorOptions} type='Types'/> + +UseErrorsResult} type='Types'/> + +ErrorsResult} type='Types'/> + +ErrorKind} 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..61fb62b53 --- /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 + +() => BrandingMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-email-list.tsx#L25) + +Hook to access branding and theme configuration. + +**Returns** + +[`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 + +**Example** + +```jsx +import { useBranding } from '@auth0/auth0-acul-react/login-id'; +function CustomTheme() { + const branding = useBranding(); +} +``` + + +() => ClientMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-email-list.tsx#L26) + +Hook to access Auth0 application (client) configuration. + +**Returns** + +[`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 + +**Example** + +```jsx +import { useClient } from '@auth0/auth0-acul-react/login-id'; +function AppInfo() { + const client = useClient(); +} +``` + + +() => OrganizationMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-email-list.tsx#L27) + +Hook to access organization context and settings. + +**Returns** + +[`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/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

No organization context

; + } +} +``` + + +() => PromptMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-email-list.tsx#L28) + +Hook to access prompt configuration and flow settings. + +**Returns** + +[`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 + +**Example** + +```jsx +import { usePrompt } from '@auth0/auth0-acul-react/login-id'; +function FlowInfo() { + const prompt = usePrompt(); +} +``` + + +() => ScreenMembersOnMfaEmailList}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-email-list.tsx#L29) + +Hook to access current screen information and metadata. + +**Returns** + +[`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 + +**Example** + +```jsx +import { useScreen } from '@auth0/auth0-acul-react/login-id'; +function ScreenDebug() { + const screen = useScreen(); +} +``` + + +() => TenantMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-email-list.tsx#L24) + +Hook to access tenant configuration and settings. + +**Returns** + +[`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/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(); +} +``` + + +() => TransactionMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-email-list.tsx#L30) + +Hook to access transaction state and authentication flow data. + +**Returns** + +[`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 + +**Example** + +```jsx +import { useTransaction } from '@auth0/auth0-acul-react/login-id'; +function TransactionInfo() { + const transaction = useTransaction(); +} +``` + + +() => UntrustedDataMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-email-list.tsx#L31) + +Hook to access untrusted data from URL parameters and form submissions. + +**Returns** + +[`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 + +**Example** + +```jsx +import { useUntrustedData } from '@auth0/auth0-acul-react/login-id'; +function PrefilledForm() { + const untrustedData = useUntrustedData(); +} +``` + + +() => UserMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-email-list.tsx#L23) + +Hook to access user information and profile data. + +**Returns** + +[`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 + +**Example** + +```jsx +import { useUser } from '@auth0/auth0-acul-react/login-id'; +function UserProfile() { + const user = useUser(); +} +``` + + + +## Functions + +void | Promise<void>}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-email-list.tsx#L37) + +**Parameters** + +**payload?** + +[`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CustomOptions) + +**Returns** + +`void` \| `Promise`\<`void`\> + + +void | Promise<void>}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-email-list.tsx#L35) + +**Parameters** + +**payload** + +[`SelectMfaEmailOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/SelectMfaEmailOptions) + +**Returns** + +`void` \| `Promise`\<`void`\> + + +MfaEmailListMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-email-list.tsx#L51) + +**Returns** + +[`MfaEmailListMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaEmailListMembers) + + + +## References + +useCurrentScreen} type='Hooks'/> + +useErrors} type='Hooks'/> + +useAuth0Themes} type='Hooks'/> + +UseErrorOptions} type='Types'/> + +UseErrorsResult} type='Types'/> + +ErrorsResult} type='Types'/> + +ErrorKind} 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..9f54c782f --- /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 + +() => BrandingMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-enroll-result.tsx#L17) + +Hook to access branding and theme configuration. + +**Returns** + +[`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 + +**Example** + +```jsx +import { useBranding } from '@auth0/auth0-acul-react/login-id'; +function CustomTheme() { + const branding = useBranding(); +} +``` + + +() => ClientMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-enroll-result.tsx#L18) + +Hook to access Auth0 application (client) configuration. + +**Returns** + +[`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 + +**Example** + +```jsx +import { useClient } from '@auth0/auth0-acul-react/login-id'; +function AppInfo() { + const client = useClient(); +} +``` + + +() => OrganizationMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-enroll-result.tsx#L19) + +Hook to access organization context and settings. + +**Returns** + +[`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/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

No organization context

; + } +} +``` + + +() => PromptMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-enroll-result.tsx#L20) + +Hook to access prompt configuration and flow settings. + +**Returns** + +[`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 + +**Example** + +```jsx +import { usePrompt } from '@auth0/auth0-acul-react/login-id'; +function FlowInfo() { + const prompt = usePrompt(); +} +``` + + +() => ScreenMembersOnMfaEnrollResult}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-enroll-result.tsx#L21) + +Hook to access current screen information and metadata. + +**Returns** + +[`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 + +**Example** + +```jsx +import { useScreen } from '@auth0/auth0-acul-react/login-id'; +function ScreenDebug() { + const screen = useScreen(); +} +``` + + +() => TenantMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-enroll-result.tsx#L16) + +Hook to access tenant configuration and settings. + +**Returns** + +[`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/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(); +} +``` + + +() => TransactionMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-enroll-result.tsx#L22) + +Hook to access transaction state and authentication flow data. + +**Returns** + +[`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 + +**Example** + +```jsx +import { useTransaction } from '@auth0/auth0-acul-react/login-id'; +function TransactionInfo() { + const transaction = useTransaction(); +} +``` + + +() => UntrustedDataMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-enroll-result.tsx#L23) + +Hook to access untrusted data from URL parameters and form submissions. + +**Returns** + +[`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 + +**Example** + +```jsx +import { useUntrustedData } from '@auth0/auth0-acul-react/login-id'; +function PrefilledForm() { + const untrustedData = useUntrustedData(); +} +``` + + +() => UserMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-enroll-result.tsx#L15) + +Hook to access user information and profile data. + +**Returns** + +[`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 + +**Example** + +```jsx +import { useUser } from '@auth0/auth0-acul-react/login-id'; +function UserProfile() { + const user = useUser(); +} +``` + + + +## Functions + +MfaEnrollResultMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-enroll-result.tsx#L38) + +**Returns** + +[`MfaEnrollResultMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaEnrollResultMembers) + + + +## References + +useCurrentScreen} type='Hooks'/> + +useErrors} type='Hooks'/> + +useAuth0Themes} type='Hooks'/> + +UseErrorOptions} type='Types'/> + +UseErrorsResult} type='Types'/> + +ErrorsResult} type='Types'/> + +ErrorKind} 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..97afc3091 --- /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 + +() => BrandingMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-login-options.tsx#L25) + +Hook to access branding and theme configuration. + +**Returns** + +[`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 + +**Example** + +```jsx +import { useBranding } from '@auth0/auth0-acul-react/login-id'; +function CustomTheme() { + const branding = useBranding(); +} +``` + + +() => ClientMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-login-options.tsx#L26) + +Hook to access Auth0 application (client) configuration. + +**Returns** + +[`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 + +**Example** + +```jsx +import { useClient } from '@auth0/auth0-acul-react/login-id'; +function AppInfo() { + const client = useClient(); +} +``` + + +() => OrganizationMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-login-options.tsx#L27) + +Hook to access organization context and settings. + +**Returns** + +[`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/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

No organization context

; + } +} +``` + + +() => PromptMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-login-options.tsx#L28) + +Hook to access prompt configuration and flow settings. + +**Returns** + +[`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 + +**Example** + +```jsx +import { usePrompt } from '@auth0/auth0-acul-react/login-id'; +function FlowInfo() { + const prompt = usePrompt(); +} +``` + + +() => ScreenMembersOnMfaLoginOptions}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-login-options.tsx#L29) + +Hook to access current screen information and metadata. + +**Returns** + +[`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 + +**Example** + +```jsx +import { useScreen } from '@auth0/auth0-acul-react/login-id'; +function ScreenDebug() { + const screen = useScreen(); +} +``` + + +() => TenantMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-login-options.tsx#L24) + +Hook to access tenant configuration and settings. + +**Returns** + +[`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/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(); +} +``` + + +() => TransactionMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-login-options.tsx#L30) + +Hook to access transaction state and authentication flow data. + +**Returns** + +[`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 + +**Example** + +```jsx +import { useTransaction } from '@auth0/auth0-acul-react/login-id'; +function TransactionInfo() { + const transaction = useTransaction(); +} +``` + + +() => UntrustedDataMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-login-options.tsx#L31) + +Hook to access untrusted data from URL parameters and form submissions. + +**Returns** + +[`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 + +**Example** + +```jsx +import { useUntrustedData } from '@auth0/auth0-acul-react/login-id'; +function PrefilledForm() { + const untrustedData = useUntrustedData(); +} +``` + + +() => UserMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-login-options.tsx#L23) + +Hook to access user information and profile data. + +**Returns** + +[`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 + +**Example** + +```jsx +import { useUser } from '@auth0/auth0-acul-react/login-id'; +function UserProfile() { + const user = useUser(); +} +``` + + + +## Functions + +void | Promise<void>}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-login-options.tsx#L35) + +**Parameters** + +**payload** + +[`LoginEnrollOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/LoginEnrollOptions) + +**Returns** + +`void` \| `Promise`\<`void`\> + + +void | Promise<void>}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-login-options.tsx#L36) + +**Parameters** + +**payload?** + +[`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CustomOptions) + +**Returns** + +`void` \| `Promise`\<`void`\> + + +MfaLoginOptionsMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-login-options.tsx#L51) + +**Returns** + +[`MfaLoginOptionsMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaLoginOptionsMembers) + + + +## References + +useCurrentScreen} type='Hooks'/> + +useErrors} type='Hooks'/> + +useAuth0Themes} type='Hooks'/> + +UseErrorOptions} type='Types'/> + +UseErrorsResult} type='Types'/> + +ErrorsResult} type='Types'/> + +ErrorKind} 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..31b204f73 --- /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 + +() => BrandingMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-otp-challenge.tsx#L25) + +Hook to access branding and theme configuration. + +**Returns** + +[`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 + +**Example** + +```jsx +import { useBranding } from '@auth0/auth0-acul-react/login-id'; +function CustomTheme() { + const branding = useBranding(); +} +``` + + +() => ClientMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-otp-challenge.tsx#L26) + +Hook to access Auth0 application (client) configuration. + +**Returns** + +[`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 + +**Example** + +```jsx +import { useClient } from '@auth0/auth0-acul-react/login-id'; +function AppInfo() { + const client = useClient(); +} +``` + + +() => OrganizationMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-otp-challenge.tsx#L27) + +Hook to access organization context and settings. + +**Returns** + +[`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/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

No organization context

; + } +} +``` + + +() => PromptMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-otp-challenge.tsx#L28) + +Hook to access prompt configuration and flow settings. + +**Returns** + +[`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 + +**Example** + +```jsx +import { usePrompt } from '@auth0/auth0-acul-react/login-id'; +function FlowInfo() { + const prompt = usePrompt(); +} +``` + + +() => ScreenMembersOnMfaOtpChallenge}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-otp-challenge.tsx#L29) + +Hook to access current screen information and metadata. + +**Returns** + +[`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 + +**Example** + +```jsx +import { useScreen } from '@auth0/auth0-acul-react/login-id'; +function ScreenDebug() { + const screen = useScreen(); +} +``` + + +() => TenantMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-otp-challenge.tsx#L24) + +Hook to access tenant configuration and settings. + +**Returns** + +[`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/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(); +} +``` + + +() => TransactionMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-otp-challenge.tsx#L30) + +Hook to access transaction state and authentication flow data. + +**Returns** + +[`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 + +**Example** + +```jsx +import { useTransaction } from '@auth0/auth0-acul-react/login-id'; +function TransactionInfo() { + const transaction = useTransaction(); +} +``` + + +() => UntrustedDataMembersOnMfaOtpChallenge}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-otp-challenge.tsx#L31) + +Hook to access untrusted data from URL parameters and form submissions. + +**Returns** + +[`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 + +**Example** + +```jsx +import { useUntrustedData } from '@auth0/auth0-acul-react/login-id'; +function PrefilledForm() { + const untrustedData = useUntrustedData(); +} +``` + + +() => UserMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-otp-challenge.tsx#L23) + +Hook to access user information and profile data. + +**Returns** + +[`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 + +**Example** + +```jsx +import { useUser } from '@auth0/auth0-acul-react/login-id'; +function UserProfile() { + const user = useUser(); +} +``` + + + +## Functions + +void | Promise<void>}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-otp-challenge.tsx#L35) + +**Parameters** + +**payload** + +[`ContinueOTPOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ContinueOTPOptions) + +**Returns** + +`void` \| `Promise`\<`void`\> + + +void | Promise<void>}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-otp-challenge.tsx#L36) + +**Parameters** + +**payload?** + +[`TryAnotherMethodMfaOtpChallengeOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TryAnotherMethodMfaOtpChallengeOptions) + +**Returns** + +`void` \| `Promise`\<`void`\> + + +MfaOtpChallengeMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-otp-challenge.tsx#L51) + +**Returns** + +[`MfaOtpChallengeMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaOtpChallengeMembers) + + + +## References + +useCurrentScreen} type='Hooks'/> + +useErrors} type='Hooks'/> + +useAuth0Themes} type='Hooks'/> + +UseErrorOptions} type='Types'/> + +UseErrorsResult} type='Types'/> + +ErrorsResult} type='Types'/> + +ErrorKind} 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..1099019b9 --- /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 + +() => BrandingMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-otp-enrollment-code.tsx#L25) + +Hook to access branding and theme configuration. + +**Returns** + +[`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 + +**Example** + +```jsx +import { useBranding } from '@auth0/auth0-acul-react/login-id'; +function CustomTheme() { + const branding = useBranding(); +} +``` + + +() => ClientMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-otp-enrollment-code.tsx#L26) + +Hook to access Auth0 application (client) configuration. + +**Returns** + +[`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 + +**Example** + +```jsx +import { useClient } from '@auth0/auth0-acul-react/login-id'; +function AppInfo() { + const client = useClient(); +} +``` + + +() => OrganizationMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-otp-enrollment-code.tsx#L27) + +Hook to access organization context and settings. + +**Returns** + +[`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/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

No organization context

; + } +} +``` + + +() => PromptMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-otp-enrollment-code.tsx#L28) + +Hook to access prompt configuration and flow settings. + +**Returns** + +[`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 + +**Example** + +```jsx +import { usePrompt } from '@auth0/auth0-acul-react/login-id'; +function FlowInfo() { + const prompt = usePrompt(); +} +``` + + +() => ScreenMembersOnMfaOtpEnrollmentCode}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-otp-enrollment-code.tsx#L29) + +Hook to access current screen information and metadata. + +**Returns** + +[`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 + +**Example** + +```jsx +import { useScreen } from '@auth0/auth0-acul-react/login-id'; +function ScreenDebug() { + const screen = useScreen(); +} +``` + + +() => TenantMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-otp-enrollment-code.tsx#L24) + +Hook to access tenant configuration and settings. + +**Returns** + +[`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/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(); +} +``` + + +() => TransactionMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-otp-enrollment-code.tsx#L30) + +Hook to access transaction state and authentication flow data. + +**Returns** + +[`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 + +**Example** + +```jsx +import { useTransaction } from '@auth0/auth0-acul-react/login-id'; +function TransactionInfo() { + const transaction = useTransaction(); +} +``` + + +() => UntrustedDataMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/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`](/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 + +**Example** + +```jsx +import { useUntrustedData } from '@auth0/auth0-acul-react/login-id'; +function PrefilledForm() { + const untrustedData = useUntrustedData(); +} +``` + + +() => UserMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-otp-enrollment-code.tsx#L23) + +Hook to access user information and profile data. + +**Returns** + +[`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 + +**Example** + +```jsx +import { useUser } from '@auth0/auth0-acul-react/login-id'; +function UserProfile() { + const user = useUser(); +} +``` + + + +## Functions + +void | Promise<void>}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-otp-enrollment-code.tsx#L35) + +**Parameters** + +**payload** + +[`MfaOtpContinueOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaOtpContinueOptions) + +**Returns** + +`void` \| `Promise`\<`void`\> + + +void | Promise<void>}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-otp-enrollment-code.tsx#L36) + +**Parameters** + +**payload?** + +[`MfaOtpTryAnotherMethodOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaOtpTryAnotherMethodOptions) + +**Returns** + +`void` \| `Promise`\<`void`\> + + +MfaOtpEnrollmentCodeMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-otp-enrollment-code.tsx#L51) + +**Returns** + +[`MfaOtpEnrollmentCodeMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaOtpEnrollmentCodeMembers) + + + +## References + +useCurrentScreen} type='Hooks'/> + +useErrors} type='Hooks'/> + +useAuth0Themes} type='Hooks'/> + +UseErrorOptions} type='Types'/> + +UseErrorsResult} type='Types'/> + +ErrorsResult} type='Types'/> + +ErrorKind} 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..95f80539e --- /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 + +() => BrandingMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-otp-enrollment-qr.tsx#L25) + +Hook to access branding and theme configuration. + +**Returns** + +[`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 + +**Example** + +```jsx +import { useBranding } from '@auth0/auth0-acul-react/login-id'; +function CustomTheme() { + const branding = useBranding(); +} +``` + + +() => ClientMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-otp-enrollment-qr.tsx#L26) + +Hook to access Auth0 application (client) configuration. + +**Returns** + +[`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 + +**Example** + +```jsx +import { useClient } from '@auth0/auth0-acul-react/login-id'; +function AppInfo() { + const client = useClient(); +} +``` + + +() => OrganizationMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-otp-enrollment-qr.tsx#L27) + +Hook to access organization context and settings. + +**Returns** + +[`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/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

No organization context

; + } +} +``` + + +() => PromptMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-otp-enrollment-qr.tsx#L28) + +Hook to access prompt configuration and flow settings. + +**Returns** + +[`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 + +**Example** + +```jsx +import { usePrompt } from '@auth0/auth0-acul-react/login-id'; +function FlowInfo() { + const prompt = usePrompt(); +} +``` + + +() => ScreenMembersOnMfaOtpEnrollmentQr}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-otp-enrollment-qr.tsx#L29) + +Hook to access current screen information and metadata. + +**Returns** + +[`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 + +**Example** + +```jsx +import { useScreen } from '@auth0/auth0-acul-react/login-id'; +function ScreenDebug() { + const screen = useScreen(); +} +``` + + +() => TenantMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-otp-enrollment-qr.tsx#L24) + +Hook to access tenant configuration and settings. + +**Returns** + +[`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/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(); +} +``` + + +() => TransactionMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-otp-enrollment-qr.tsx#L30) + +Hook to access transaction state and authentication flow data. + +**Returns** + +[`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 + +**Example** + +```jsx +import { useTransaction } from '@auth0/auth0-acul-react/login-id'; +function TransactionInfo() { + const transaction = useTransaction(); +} +``` + + +() => UntrustedDataMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/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`](/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 + +**Example** + +```jsx +import { useUntrustedData } from '@auth0/auth0-acul-react/login-id'; +function PrefilledForm() { + const untrustedData = useUntrustedData(); +} +``` + + +() => UserMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-otp-enrollment-qr.tsx#L23) + +Hook to access user information and profile data. + +**Returns** + +[`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 + +**Example** + +```jsx +import { useUser } from '@auth0/auth0-acul-react/login-id'; +function UserProfile() { + const user = useUser(); +} +``` + + + +## Functions + +void | Promise<void>}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-otp-enrollment-qr.tsx#L36) + +**Parameters** + +**payload** + +[`MfaOtpEnrollmentQrContinueOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaOtpEnrollmentQrContinueOptions) + +**Returns** + +`void` \| `Promise`\<`void`\> + + +void | Promise<void>}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-otp-enrollment-qr.tsx#L35) + +**Parameters** + +**payload?** + +[`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CustomOptions) + +**Returns** + +`void` \| `Promise`\<`void`\> + + +void | Promise<void>}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-otp-enrollment-qr.tsx#L37) + +**Parameters** + +**payload?** + +[`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CustomOptions) + +**Returns** + +`void` \| `Promise`\<`void`\> + + +MfaOtpEnrollmentQrMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-otp-enrollment-qr.tsx#L52) + +**Returns** + +[`MfaOtpEnrollmentQrMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaOtpEnrollmentQrMembers) + + + +## References + +useCurrentScreen} type='Hooks'/> + +useErrors} type='Hooks'/> + +useAuth0Themes} type='Hooks'/> + +UseErrorOptions} type='Types'/> + +UseErrorsResult} type='Types'/> + +ErrorsResult} type='Types'/> + +ErrorKind} 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..265e07262 --- /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 + +() => BrandingMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-phone-challenge.tsx#L26) + +Hook to access branding and theme configuration. + +**Returns** + +[`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 + +**Example** + +```jsx +import { useBranding } from '@auth0/auth0-acul-react/login-id'; +function CustomTheme() { + const branding = useBranding(); +} +``` + + +() => ClientMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-phone-challenge.tsx#L27) + +Hook to access Auth0 application (client) configuration. + +**Returns** + +[`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 + +**Example** + +```jsx +import { useClient } from '@auth0/auth0-acul-react/login-id'; +function AppInfo() { + const client = useClient(); +} +``` + + +() => OrganizationMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-phone-challenge.tsx#L28) + +Hook to access organization context and settings. + +**Returns** + +[`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/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

No organization context

; + } +} +``` + + +() => PromptMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-phone-challenge.tsx#L29) + +Hook to access prompt configuration and flow settings. + +**Returns** + +[`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 + +**Example** + +```jsx +import { usePrompt } from '@auth0/auth0-acul-react/login-id'; +function FlowInfo() { + const prompt = usePrompt(); +} +``` + + +() => ScreenMembersOnMfaPhoneChallenge}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-phone-challenge.tsx#L30) + +Hook to access current screen information and metadata. + +**Returns** + +[`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 + +**Example** + +```jsx +import { useScreen } from '@auth0/auth0-acul-react/login-id'; +function ScreenDebug() { + const screen = useScreen(); +} +``` + + +() => TenantMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-phone-challenge.tsx#L25) + +Hook to access tenant configuration and settings. + +**Returns** + +[`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/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(); +} +``` + + +() => TransactionMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-phone-challenge.tsx#L31) + +Hook to access transaction state and authentication flow data. + +**Returns** + +[`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 + +**Example** + +```jsx +import { useTransaction } from '@auth0/auth0-acul-react/login-id'; +function TransactionInfo() { + const transaction = useTransaction(); +} +``` + + +() => UntrustedDataMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-phone-challenge.tsx#L32) + +Hook to access untrusted data from URL parameters and form submissions. + +**Returns** + +[`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 + +**Example** + +```jsx +import { useUntrustedData } from '@auth0/auth0-acul-react/login-id'; +function PrefilledForm() { + const untrustedData = useUntrustedData(); +} +``` + + +() => UserMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-phone-challenge.tsx#L24) + +Hook to access user information and profile data. + +**Returns** + +[`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 + +**Example** + +```jsx +import { useUser } from '@auth0/auth0-acul-react/login-id'; +function UserProfile() { + const user = useUser(); +} +``` + + + +## Functions + +void | Promise<void>}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-phone-challenge.tsx#L36) + +**Parameters** + +**payload** + +[`MfaPhoneChallengeContinueOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaPhoneChallengeContinueOptions) + +**Returns** + +`void` \| `Promise`\<`void`\> + + +void | Promise<void>}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-phone-challenge.tsx#L37) + +**Parameters** + +**payload?** + +[`MfaPhoneChallengePickPhoneOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaPhoneChallengePickPhoneOptions) + +**Returns** + +`void` \| `Promise`\<`void`\> + + +void | Promise<void>}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-phone-challenge.tsx#L38) + +**Parameters** + +**payload?** + +[`MfaPhoneChallengePickAuthenticatorOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaPhoneChallengePickAuthenticatorOptions) + +**Returns** + +`void` \| `Promise`\<`void`\> + + +MfaPhoneChallengeMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-phone-challenge.tsx#L53) + +**Returns** + +[`MfaPhoneChallengeMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaPhoneChallengeMembers) + + + +## References + +useCurrentScreen} type='Hooks'/> + +useErrors} type='Hooks'/> + +useAuth0Themes} type='Hooks'/> + +UseErrorOptions} type='Types'/> + +UseErrorsResult} type='Types'/> + +ErrorsResult} type='Types'/> + +ErrorKind} 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..0506abe76 --- /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 + +() => BrandingMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-phone-enrollment.tsx#L25) + +Hook to access branding and theme configuration. + +**Returns** + +[`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 + +**Example** + +```jsx +import { useBranding } from '@auth0/auth0-acul-react/login-id'; +function CustomTheme() { + const branding = useBranding(); +} +``` + + +() => ClientMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-phone-enrollment.tsx#L26) + +Hook to access Auth0 application (client) configuration. + +**Returns** + +[`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 + +**Example** + +```jsx +import { useClient } from '@auth0/auth0-acul-react/login-id'; +function AppInfo() { + const client = useClient(); +} +``` + + +() => OrganizationMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-phone-enrollment.tsx#L27) + +Hook to access organization context and settings. + +**Returns** + +[`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/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

No organization context

; + } +} +``` + + +() => PromptMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-phone-enrollment.tsx#L28) + +Hook to access prompt configuration and flow settings. + +**Returns** + +[`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 + +**Example** + +```jsx +import { usePrompt } from '@auth0/auth0-acul-react/login-id'; +function FlowInfo() { + const prompt = usePrompt(); +} +``` + + +() => ScreenMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-phone-enrollment.tsx#L29) + +Hook to access current screen information and metadata. + +**Returns** + +[`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 + +**Example** + +```jsx +import { useScreen } from '@auth0/auth0-acul-react/login-id'; +function ScreenDebug() { + const screen = useScreen(); +} +``` + + +() => TenantMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-phone-enrollment.tsx#L24) + +Hook to access tenant configuration and settings. + +**Returns** + +[`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/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(); +} +``` + + +() => TransactionMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-phone-enrollment.tsx#L30) + +Hook to access transaction state and authentication flow data. + +**Returns** + +[`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 + +**Example** + +```jsx +import { useTransaction } from '@auth0/auth0-acul-react/login-id'; +function TransactionInfo() { + const transaction = useTransaction(); +} +``` + + +() => UntrustedDataMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-phone-enrollment.tsx#L31) + +Hook to access untrusted data from URL parameters and form submissions. + +**Returns** + +[`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 + +**Example** + +```jsx +import { useUntrustedData } from '@auth0/auth0-acul-react/login-id'; +function PrefilledForm() { + const untrustedData = useUntrustedData(); +} +``` + + +() => UserMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-phone-enrollment.tsx#L23) + +Hook to access user information and profile data. + +**Returns** + +[`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 + +**Example** + +```jsx +import { useUser } from '@auth0/auth0-acul-react/login-id'; +function UserProfile() { + const user = useUser(); +} +``` + + + +## Functions + +void | Promise<void>}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-phone-enrollment.tsx#L37) + +**Parameters** + +**payload** + +[`MfaPhoneEnrollmentContinueOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaPhoneEnrollmentContinueOptions) + +**Returns** + +`void` \| `Promise`\<`void`\> + + +void | Promise<void>}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-phone-enrollment.tsx#L35) + +**Parameters** + +**payload?** + +[`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CustomOptions) + +**Returns** + +`void` \| `Promise`\<`void`\> + + +void | Promise<void>}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-phone-enrollment.tsx#L39) + +**Parameters** + +**payload?** + +[`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CustomOptions) + +**Returns** + +`void` \| `Promise`\<`void`\> + + +MfaPhoneEnrollmentMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-phone-enrollment.tsx#L54) + +**Returns** + +[`MfaPhoneEnrollmentMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaPhoneEnrollmentMembers) + + + +## References + +useCurrentScreen} type='Hooks'/> + +useErrors} type='Hooks'/> + +useAuth0Themes} type='Hooks'/> + +UseErrorOptions} type='Types'/> + +UseErrorsResult} type='Types'/> + +ErrorsResult} type='Types'/> + +ErrorKind} 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..892fee4c2 --- /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 + +() => BrandingMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-push-challenge-push.tsx#L25) + +Hook to access branding and theme configuration. + +**Returns** + +[`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 + +**Example** + +```jsx +import { useBranding } from '@auth0/auth0-acul-react/login-id'; +function CustomTheme() { + const branding = useBranding(); +} +``` + + +() => ClientMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-push-challenge-push.tsx#L26) + +Hook to access Auth0 application (client) configuration. + +**Returns** + +[`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 + +**Example** + +```jsx +import { useClient } from '@auth0/auth0-acul-react/login-id'; +function AppInfo() { + const client = useClient(); +} +``` + + +() => OrganizationMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-push-challenge-push.tsx#L27) + +Hook to access organization context and settings. + +**Returns** + +[`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/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

No organization context

; + } +} +``` + + +() => PromptMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-push-challenge-push.tsx#L28) + +Hook to access prompt configuration and flow settings. + +**Returns** + +[`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 + +**Example** + +```jsx +import { usePrompt } from '@auth0/auth0-acul-react/login-id'; +function FlowInfo() { + const prompt = usePrompt(); +} +``` + + +() => ScreenMembersOnMfaPushChallengePush}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-push-challenge-push.tsx#L29) + +Hook to access current screen information and metadata. + +**Returns** + +[`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 + +**Example** + +```jsx +import { useScreen } from '@auth0/auth0-acul-react/login-id'; +function ScreenDebug() { + const screen = useScreen(); +} +``` + + +() => TenantMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-push-challenge-push.tsx#L24) + +Hook to access tenant configuration and settings. + +**Returns** + +[`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/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(); +} +``` + + +() => TransactionMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-push-challenge-push.tsx#L30) + +Hook to access transaction state and authentication flow data. + +**Returns** + +[`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 + +**Example** + +```jsx +import { useTransaction } from '@auth0/auth0-acul-react/login-id'; +function TransactionInfo() { + const transaction = useTransaction(); +} +``` + + +() => UntrustedDataMembersOnMfaPushChallengePush}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/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`](/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 + +**Example** + +```jsx +import { useUntrustedData } from '@auth0/auth0-acul-react/login-id'; +function PrefilledForm() { + const untrustedData = useUntrustedData(); +} +``` + + +() => UserMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-push-challenge-push.tsx#L23) + +Hook to access user information and profile data. + +**Returns** + +[`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 + +**Example** + +```jsx +import { useUser } from '@auth0/auth0-acul-react/login-id'; +function UserProfile() { + const user = useUser(); +} +``` + + + +## Functions + +void | Promise<void>}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-push-challenge-push.tsx#L35) + +**Parameters** + +**payload?** + +[`WithRememberOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/WithRememberOptions) + +**Returns** + +`void` \| `Promise`\<`void`\> + + +void | Promise<void>}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-push-challenge-push.tsx#L39) + +**Parameters** + +**payload?** + +[`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CustomOptions) + +**Returns** + +`void` \| `Promise`\<`void`\> + + +void | Promise<void>}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-push-challenge-push.tsx#L37) + +**Parameters** + +**payload?** + +[`WithRememberOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/WithRememberOptions) + +**Returns** + +`void` \| `Promise`\<`void`\> + + +void | Promise<void>}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-push-challenge-push.tsx#L41) + +**Parameters** + +**payload?** + +[`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CustomOptions) + +**Returns** + +`void` \| `Promise`\<`void`\> + + +MfaPushChallengePushMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-push-challenge-push.tsx#L59) + +**Returns** + +[`MfaPushChallengePushMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaPushChallengePushMembers) + + + +## References + +useMfaPolling} type='Hooks'/> + +useCurrentScreen} type='Hooks'/> + +useErrors} type='Hooks'/> + +useAuth0Themes} type='Hooks'/> + +UseErrorOptions} type='Types'/> + +UseErrorsResult} type='Types'/> + +ErrorsResult} type='Types'/> + +ErrorKind} 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..ff67f3a41 --- /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 + +() => BrandingMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-push-enrollment-qr.tsx#L24) + +Hook to access branding and theme configuration. + +**Returns** + +[`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 + +**Example** + +```jsx +import { useBranding } from '@auth0/auth0-acul-react/login-id'; +function CustomTheme() { + const branding = useBranding(); +} +``` + + +() => ClientMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-push-enrollment-qr.tsx#L25) + +Hook to access Auth0 application (client) configuration. + +**Returns** + +[`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 + +**Example** + +```jsx +import { useClient } from '@auth0/auth0-acul-react/login-id'; +function AppInfo() { + const client = useClient(); +} +``` + + +() => OrganizationMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-push-enrollment-qr.tsx#L26) + +Hook to access organization context and settings. + +**Returns** + +[`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/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

No organization context

; + } +} +``` + + +() => PromptMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-push-enrollment-qr.tsx#L27) + +Hook to access prompt configuration and flow settings. + +**Returns** + +[`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 + +**Example** + +```jsx +import { usePrompt } from '@auth0/auth0-acul-react/login-id'; +function FlowInfo() { + const prompt = usePrompt(); +} +``` + + +() => ScreenMembersOnMfaPushEnrollmentQr}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-push-enrollment-qr.tsx#L28) + +Hook to access current screen information and metadata. + +**Returns** + +[`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 + +**Example** + +```jsx +import { useScreen } from '@auth0/auth0-acul-react/login-id'; +function ScreenDebug() { + const screen = useScreen(); +} +``` + + +() => TenantMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-push-enrollment-qr.tsx#L23) + +Hook to access tenant configuration and settings. + +**Returns** + +[`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/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(); +} +``` + + +() => TransactionMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-push-enrollment-qr.tsx#L29) + +Hook to access transaction state and authentication flow data. + +**Returns** + +[`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 + +**Example** + +```jsx +import { useTransaction } from '@auth0/auth0-acul-react/login-id'; +function TransactionInfo() { + const transaction = useTransaction(); +} +``` + + +() => UntrustedDataMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/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`](/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 + +**Example** + +```jsx +import { useUntrustedData } from '@auth0/auth0-acul-react/login-id'; +function PrefilledForm() { + const untrustedData = useUntrustedData(); +} +``` + + +() => UserMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-push-enrollment-qr.tsx#L22) + +Hook to access user information and profile data. + +**Returns** + +[`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 + +**Example** + +```jsx +import { useUser } from '@auth0/auth0-acul-react/login-id'; +function UserProfile() { + const user = useUser(); +} +``` + + + +## Functions + +void | Promise<void>}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-push-enrollment-qr.tsx#L34) + +**Parameters** + +**payload?** + +[`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CustomOptions) + +**Returns** + +`void` \| `Promise`\<`void`\> + + +MfaPushEnrollmentQrMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-push-enrollment-qr.tsx#L52) + +**Returns** + +[`MfaPushEnrollmentQrMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaPushEnrollmentQrMembers) + + + +## References + +useMfaPolling} type='Hooks'/> + +useCurrentScreen} type='Hooks'/> + +useErrors} type='Hooks'/> + +useAuth0Themes} type='Hooks'/> + +UseErrorOptions} type='Types'/> + +UseErrorsResult} type='Types'/> + +ErrorsResult} type='Types'/> + +ErrorKind} 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..6ce2a2ad4 --- /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 + +() => BrandingMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-push-list.tsx#L25) + +Hook to access branding and theme configuration. + +**Returns** + +[`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 + +**Example** + +```jsx +import { useBranding } from '@auth0/auth0-acul-react/login-id'; +function CustomTheme() { + const branding = useBranding(); +} +``` + + +() => ClientMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-push-list.tsx#L26) + +Hook to access Auth0 application (client) configuration. + +**Returns** + +[`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 + +**Example** + +```jsx +import { useClient } from '@auth0/auth0-acul-react/login-id'; +function AppInfo() { + const client = useClient(); +} +``` + + +() => OrganizationMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-push-list.tsx#L27) + +Hook to access organization context and settings. + +**Returns** + +[`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/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

No organization context

; + } +} +``` + + +() => PromptMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-push-list.tsx#L28) + +Hook to access prompt configuration and flow settings. + +**Returns** + +[`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 + +**Example** + +```jsx +import { usePrompt } from '@auth0/auth0-acul-react/login-id'; +function FlowInfo() { + const prompt = usePrompt(); +} +``` + + +() => ScreenMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-push-list.tsx#L29) + +Hook to access current screen information and metadata. + +**Returns** + +[`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 + +**Example** + +```jsx +import { useScreen } from '@auth0/auth0-acul-react/login-id'; +function ScreenDebug() { + const screen = useScreen(); +} +``` + + +() => TenantMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-push-list.tsx#L24) + +Hook to access tenant configuration and settings. + +**Returns** + +[`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/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(); +} +``` + + +() => TransactionMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-push-list.tsx#L30) + +Hook to access transaction state and authentication flow data. + +**Returns** + +[`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 + +**Example** + +```jsx +import { useTransaction } from '@auth0/auth0-acul-react/login-id'; +function TransactionInfo() { + const transaction = useTransaction(); +} +``` + + +() => UntrustedDataMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-push-list.tsx#L31) + +Hook to access untrusted data from URL parameters and form submissions. + +**Returns** + +[`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 + +**Example** + +```jsx +import { useUntrustedData } from '@auth0/auth0-acul-react/login-id'; +function PrefilledForm() { + const untrustedData = useUntrustedData(); +} +``` + + +() => UserMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-push-list.tsx#L23) + +Hook to access user information and profile data. + +**Returns** + +[`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 + +**Example** + +```jsx +import { useUser } from '@auth0/auth0-acul-react/login-id'; +function UserProfile() { + const user = useUser(); +} +``` + + + +## Functions + +void | Promise<void>}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-push-list.tsx#L37) + +**Parameters** + +**payload?** + +[`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CustomOptions) + +**Returns** + +`void` \| `Promise`\<`void`\> + + +void | Promise<void>}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-push-list.tsx#L35) + +**Parameters** + +**payload** + +[`SelectMfaPushDeviceOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/SelectMfaPushDeviceOptions) + +**Returns** + +`void` \| `Promise`\<`void`\> + + +MfaPushListMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-push-list.tsx#L51) + +**Returns** + +[`MfaPushListMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaPushListMembers) + + + +## References + +useCurrentScreen} type='Hooks'/> + +useErrors} type='Hooks'/> + +useAuth0Themes} type='Hooks'/> + +UseErrorOptions} type='Types'/> + +UseErrorsResult} type='Types'/> + +ErrorsResult} type='Types'/> + +ErrorKind} 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..72ad3be22 --- /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 + +() => BrandingMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-push-welcome.tsx#L21) + +Hook to access branding and theme configuration. + +**Returns** + +[`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 + +**Example** + +```jsx +import { useBranding } from '@auth0/auth0-acul-react/login-id'; +function CustomTheme() { + const branding = useBranding(); +} +``` + + +() => ClientMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-push-welcome.tsx#L22) + +Hook to access Auth0 application (client) configuration. + +**Returns** + +[`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 + +**Example** + +```jsx +import { useClient } from '@auth0/auth0-acul-react/login-id'; +function AppInfo() { + const client = useClient(); +} +``` + + +() => OrganizationMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-push-welcome.tsx#L23) + +Hook to access organization context and settings. + +**Returns** + +[`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/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

No organization context

; + } +} +``` + + +() => PromptMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-push-welcome.tsx#L24) + +Hook to access prompt configuration and flow settings. + +**Returns** + +[`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 + +**Example** + +```jsx +import { usePrompt } from '@auth0/auth0-acul-react/login-id'; +function FlowInfo() { + const prompt = usePrompt(); +} +``` + + +() => ScreenMembersOnMfaPushWelcome}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-push-welcome.tsx#L25) + +Hook to access current screen information and metadata. + +**Returns** + +[`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 + +**Example** + +```jsx +import { useScreen } from '@auth0/auth0-acul-react/login-id'; +function ScreenDebug() { + const screen = useScreen(); +} +``` + + +() => TenantMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-push-welcome.tsx#L20) + +Hook to access tenant configuration and settings. + +**Returns** + +[`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/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(); +} +``` + + +() => TransactionMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-push-welcome.tsx#L26) + +Hook to access transaction state and authentication flow data. + +**Returns** + +[`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 + +**Example** + +```jsx +import { useTransaction } from '@auth0/auth0-acul-react/login-id'; +function TransactionInfo() { + const transaction = useTransaction(); +} +``` + + +() => UntrustedDataMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-push-welcome.tsx#L27) + +Hook to access untrusted data from URL parameters and form submissions. + +**Returns** + +[`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 + +**Example** + +```jsx +import { useUntrustedData } from '@auth0/auth0-acul-react/login-id'; +function PrefilledForm() { + const untrustedData = useUntrustedData(); +} +``` + + +() => UserMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-push-welcome.tsx#L19) + +Hook to access user information and profile data. + +**Returns** + +[`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 + +**Example** + +```jsx +import { useUser } from '@auth0/auth0-acul-react/login-id'; +function UserProfile() { + const user = useUser(); +} +``` + + + +## Functions + +void | Promise<void>}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-push-welcome.tsx#L31) + +**Parameters** + +**payload?** + +[`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CustomOptions) + +**Returns** + +`void` \| `Promise`\<`void`\> + + +void | Promise<void>}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-push-welcome.tsx#L32) + +**Parameters** + +**payload?** + +[`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CustomOptions) + +**Returns** + +`void` \| `Promise`\<`void`\> + + +MfaPushWelcomeMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-push-welcome.tsx#L47) + +**Returns** + +[`MfaPushWelcomeMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaPushWelcomeMembers) + + + +## References + +useCurrentScreen} type='Hooks'/> + +useErrors} type='Hooks'/> + +useAuth0Themes} type='Hooks'/> + +UseErrorOptions} type='Types'/> + +UseErrorsResult} type='Types'/> + +ErrorsResult} type='Types'/> + +ErrorKind} 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..41f67da5f --- /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 + +() => BrandingMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-recovery-code-challenge-new-code.tsx#L26) + +Hook to access branding and theme configuration. + +**Returns** + +[`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 + +**Example** + +```jsx +import { useBranding } from '@auth0/auth0-acul-react/login-id'; +function CustomTheme() { + const branding = useBranding(); +} +``` + + +() => ClientMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-recovery-code-challenge-new-code.tsx#L27) + +Hook to access Auth0 application (client) configuration. + +**Returns** + +[`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 + +**Example** + +```jsx +import { useClient } from '@auth0/auth0-acul-react/login-id'; +function AppInfo() { + const client = useClient(); +} +``` + + +() => OrganizationMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-recovery-code-challenge-new-code.tsx#L28) + +Hook to access organization context and settings. + +**Returns** + +[`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/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

No organization context

; + } +} +``` + + +() => PromptMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-recovery-code-challenge-new-code.tsx#L29) + +Hook to access prompt configuration and flow settings. + +**Returns** + +[`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 + +**Example** + +```jsx +import { usePrompt } from '@auth0/auth0-acul-react/login-id'; +function FlowInfo() { + const prompt = usePrompt(); +} +``` + + +() => ScreenMembersOnMfaRecoveryCodeChallengeNewCode}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-recovery-code-challenge-new-code.tsx#L30) + +Hook to access current screen information and metadata. + +**Returns** + +[`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 + +**Example** + +```jsx +import { useScreen } from '@auth0/auth0-acul-react/login-id'; +function ScreenDebug() { + const screen = useScreen(); +} +``` + + +() => TenantMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-recovery-code-challenge-new-code.tsx#L25) + +Hook to access tenant configuration and settings. + +**Returns** + +[`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/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(); +} +``` + + +() => TransactionMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/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`](/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 + +**Example** + +```jsx +import { useTransaction } from '@auth0/auth0-acul-react/login-id'; +function TransactionInfo() { + const transaction = useTransaction(); +} +``` + + +() => UntrustedDataMembers}> +> **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/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. + +**Returns** + +[`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 + +**Example** + +```jsx +import { useUntrustedData } from '@auth0/auth0-acul-react/login-id'; +function PrefilledForm() { + const untrustedData = useUntrustedData(); +} +``` + + +() => UserMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-recovery-code-challenge-new-code.tsx#L24) + +Hook to access user information and profile data. + +**Returns** + +[`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 + +**Example** + +```jsx +import { useUser } from '@auth0/auth0-acul-react/login-id'; +function UserProfile() { + const user = useUser(); +} +``` + + + +## Functions + +void | Promise<void>}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-recovery-code-challenge-new-code.tsx#L36) + +**Parameters** + +**payload?** + +[`MfaRecoveryCodeChallengeNewCodeContinueOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaRecoveryCodeChallengeNewCodeContinueOptions) + +**Returns** + +`void` \| `Promise`\<`void`\> + + +MfaRecoveryCodeChallengeNewCodeMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-recovery-code-challenge-new-code.tsx#L50) + +**Returns** + +[`MfaRecoveryCodeChallengeNewCodeMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaRecoveryCodeChallengeNewCodeMembers) + + + +## References + +useCurrentScreen} type='Hooks'/> + +useErrors} type='Hooks'/> + +useAuth0Themes} type='Hooks'/> + +UseErrorOptions} type='Types'/> + +UseErrorsResult} type='Types'/> + +ErrorsResult} type='Types'/> + +ErrorKind} 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..01f8afec8 --- /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 + +() => BrandingMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-recovery-code-challenge.tsx#L25) + +Hook to access branding and theme configuration. + +**Returns** + +[`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 + +**Example** + +```jsx +import { useBranding } from '@auth0/auth0-acul-react/login-id'; +function CustomTheme() { + const branding = useBranding(); +} +``` + + +() => ClientMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-recovery-code-challenge.tsx#L26) + +Hook to access Auth0 application (client) configuration. + +**Returns** + +[`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 + +**Example** + +```jsx +import { useClient } from '@auth0/auth0-acul-react/login-id'; +function AppInfo() { + const client = useClient(); +} +``` + + +() => OrganizationMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-recovery-code-challenge.tsx#L27) + +Hook to access organization context and settings. + +**Returns** + +[`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/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

No organization context

; + } +} +``` + + +() => PromptMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-recovery-code-challenge.tsx#L28) + +Hook to access prompt configuration and flow settings. + +**Returns** + +[`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 + +**Example** + +```jsx +import { usePrompt } from '@auth0/auth0-acul-react/login-id'; +function FlowInfo() { + const prompt = usePrompt(); +} +``` + + +() => ScreenMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-recovery-code-challenge.tsx#L29) + +Hook to access current screen information and metadata. + +**Returns** + +[`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 + +**Example** + +```jsx +import { useScreen } from '@auth0/auth0-acul-react/login-id'; +function ScreenDebug() { + const screen = useScreen(); +} +``` + + +() => TenantMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-recovery-code-challenge.tsx#L24) + +Hook to access tenant configuration and settings. + +**Returns** + +[`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/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(); +} +``` + + +() => TransactionMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-recovery-code-challenge.tsx#L30) + +Hook to access transaction state and authentication flow data. + +**Returns** + +[`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 + +**Example** + +```jsx +import { useTransaction } from '@auth0/auth0-acul-react/login-id'; +function TransactionInfo() { + const transaction = useTransaction(); +} +``` + + +() => UntrustedDataMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/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`](/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 + +**Example** + +```jsx +import { useUntrustedData } from '@auth0/auth0-acul-react/login-id'; +function PrefilledForm() { + const untrustedData = useUntrustedData(); +} +``` + + +() => UserMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-recovery-code-challenge.tsx#L23) + +Hook to access user information and profile data. + +**Returns** + +[`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 + +**Example** + +```jsx +import { useUser } from '@auth0/auth0-acul-react/login-id'; +function UserProfile() { + const user = useUser(); +} +``` + + + +## Functions + +void | Promise<void>}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-recovery-code-challenge.tsx#L35) + +**Parameters** + +**payload** + +[`MfaRecoveryCodeChallengeContinueOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaRecoveryCodeChallengeContinueOptions) + +**Returns** + +`void` \| `Promise`\<`void`\> + + +void | Promise<void>}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-recovery-code-challenge.tsx#L36) + +**Parameters** + +**payload?** + +[`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CustomOptions) + +**Returns** + +`void` \| `Promise`\<`void`\> + + +MfaRecoveryCodeChallengeMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-recovery-code-challenge.tsx#L51) + +**Returns** + +[`MfaRecoveryCodeChallengeMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaRecoveryCodeChallengeMembers) + + + +## References + +useCurrentScreen} type='Hooks'/> + +useErrors} type='Hooks'/> + +useAuth0Themes} type='Hooks'/> + +UseErrorOptions} type='Types'/> + +UseErrorsResult} type='Types'/> + +ErrorsResult} type='Types'/> + +ErrorKind} 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..a941a1c8a --- /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 + +() => BrandingMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-recovery-code-enrollment.tsx#L24) + +Hook to access branding and theme configuration. + +**Returns** + +[`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 + +**Example** + +```jsx +import { useBranding } from '@auth0/auth0-acul-react/login-id'; +function CustomTheme() { + const branding = useBranding(); +} +``` + + +() => ClientMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-recovery-code-enrollment.tsx#L25) + +Hook to access Auth0 application (client) configuration. + +**Returns** + +[`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 + +**Example** + +```jsx +import { useClient } from '@auth0/auth0-acul-react/login-id'; +function AppInfo() { + const client = useClient(); +} +``` + + +() => OrganizationMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-recovery-code-enrollment.tsx#L26) + +Hook to access organization context and settings. + +**Returns** + +[`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/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

No organization context

; + } +} +``` + + +() => PromptMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-recovery-code-enrollment.tsx#L27) + +Hook to access prompt configuration and flow settings. + +**Returns** + +[`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 + +**Example** + +```jsx +import { usePrompt } from '@auth0/auth0-acul-react/login-id'; +function FlowInfo() { + const prompt = usePrompt(); +} +``` + + +() => ScreenMembersOnMfaRecoveryCodeEnrollment}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-recovery-code-enrollment.tsx#L28) + +Hook to access current screen information and metadata. + +**Returns** + +[`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 + +**Example** + +```jsx +import { useScreen } from '@auth0/auth0-acul-react/login-id'; +function ScreenDebug() { + const screen = useScreen(); +} +``` + + +() => TenantMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-recovery-code-enrollment.tsx#L23) + +Hook to access tenant configuration and settings. + +**Returns** + +[`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/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(); +} +``` + + +() => TransactionMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-recovery-code-enrollment.tsx#L29) + +Hook to access transaction state and authentication flow data. + +**Returns** + +[`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 + +**Example** + +```jsx +import { useTransaction } from '@auth0/auth0-acul-react/login-id'; +function TransactionInfo() { + const transaction = useTransaction(); +} +``` + + +() => UntrustedDataMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/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`](/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 + +**Example** + +```jsx +import { useUntrustedData } from '@auth0/auth0-acul-react/login-id'; +function PrefilledForm() { + const untrustedData = useUntrustedData(); +} +``` + + +() => UserMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-recovery-code-enrollment.tsx#L22) + +Hook to access user information and profile data. + +**Returns** + +[`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 + +**Example** + +```jsx +import { useUser } from '@auth0/auth0-acul-react/login-id'; +function UserProfile() { + const user = useUser(); +} +``` + + + +## Functions + +void | Promise<void>}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-recovery-code-enrollment.tsx#L34) + +**Parameters** + +**payload** + +[`MfaRecoveryCodeEnrollmentContinueOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaRecoveryCodeEnrollmentContinueOptions) + +**Returns** + +`void` \| `Promise`\<`void`\> + + +MfaRecoveryCodeEnrollmentMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-recovery-code-enrollment.tsx#L49) + +**Returns** + +[`MfaRecoveryCodeEnrollmentMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaRecoveryCodeEnrollmentMembers) + + + +## References + +useCurrentScreen} type='Hooks'/> + +useErrors} type='Hooks'/> + +useAuth0Themes} type='Hooks'/> + +UseErrorOptions} type='Types'/> + +UseErrorsResult} type='Types'/> + +ErrorsResult} type='Types'/> + +ErrorKind} 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..e3da1488c --- /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 + +() => BrandingMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-sms-challenge.tsx#L25) + +Hook to access branding and theme configuration. + +**Returns** + +[`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 + +**Example** + +```jsx +import { useBranding } from '@auth0/auth0-acul-react/login-id'; +function CustomTheme() { + const branding = useBranding(); +} +``` + + +() => ClientMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-sms-challenge.tsx#L26) + +Hook to access Auth0 application (client) configuration. + +**Returns** + +[`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 + +**Example** + +```jsx +import { useClient } from '@auth0/auth0-acul-react/login-id'; +function AppInfo() { + const client = useClient(); +} +``` + + +() => OrganizationMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-sms-challenge.tsx#L27) + +Hook to access organization context and settings. + +**Returns** + +[`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/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

No organization context

; + } +} +``` + + +() => PromptMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-sms-challenge.tsx#L28) + +Hook to access prompt configuration and flow settings. + +**Returns** + +[`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 + +**Example** + +```jsx +import { usePrompt } from '@auth0/auth0-acul-react/login-id'; +function FlowInfo() { + const prompt = usePrompt(); +} +``` + + +() => ScreenMembersOnMfaSmsChallenge}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-sms-challenge.tsx#L29) + +Hook to access current screen information and metadata. + +**Returns** + +[`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 + +**Example** + +```jsx +import { useScreen } from '@auth0/auth0-acul-react/login-id'; +function ScreenDebug() { + const screen = useScreen(); +} +``` + + +() => TenantMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-sms-challenge.tsx#L24) + +Hook to access tenant configuration and settings. + +**Returns** + +[`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/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(); +} +``` + + +() => TransactionMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-sms-challenge.tsx#L30) + +Hook to access transaction state and authentication flow data. + +**Returns** + +[`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 + +**Example** + +```jsx +import { useTransaction } from '@auth0/auth0-acul-react/login-id'; +function TransactionInfo() { + const transaction = useTransaction(); +} +``` + + +() => UntrustedDataMembersOnMfaSmsChallenge}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-sms-challenge.tsx#L31) + +Hook to access untrusted data from URL parameters and form submissions. + +**Returns** + +[`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 + +**Example** + +```jsx +import { useUntrustedData } from '@auth0/auth0-acul-react/login-id'; +function PrefilledForm() { + const untrustedData = useUntrustedData(); +} +``` + + +() => UserMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-sms-challenge.tsx#L23) + +Hook to access user information and profile data. + +**Returns** + +[`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 + +**Example** + +```jsx +import { useUser } from '@auth0/auth0-acul-react/login-id'; +function UserProfile() { + const user = useUser(); +} +``` + + + +## Functions + +void | Promise<void>}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-sms-challenge.tsx#L35) + +**Parameters** + +**payload** + +[`MfaSmsChallengeOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaSmsChallengeOptions) + +**Returns** + +`void` \| `Promise`\<`void`\> + + +void | Promise<void>}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-sms-challenge.tsx#L41) + +**Parameters** + +**payload?** + +[`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CustomOptions) + +**Returns** + +`void` \| `Promise`\<`void`\> + + +void | Promise<void>}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-sms-challenge.tsx#L37) + +**Parameters** + +**payload?** + +[`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CustomOptions) + +**Returns** + +`void` \| `Promise`\<`void`\> + + +void | Promise<void>}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-sms-challenge.tsx#L38) + +**Parameters** + +**payload?** + +[`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CustomOptions) + +**Returns** + +`void` \| `Promise`\<`void`\> + + +void | Promise<void>}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-sms-challenge.tsx#L39) + +**Parameters** + +**payload?** + +[`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CustomOptions) + +**Returns** + +`void` \| `Promise`\<`void`\> + + +MfaSmsChallengeMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-sms-challenge.tsx#L58) + +**Returns** + +[`MfaSmsChallengeMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaSmsChallengeMembers) + + + +## References + +useResend} type='Hooks'/> + +useCurrentScreen} type='Hooks'/> + +useErrors} type='Hooks'/> + +useAuth0Themes} type='Hooks'/> + +UseErrorOptions} type='Types'/> + +UseErrorsResult} type='Types'/> + +ErrorsResult} type='Types'/> + +ErrorKind} 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..bbac47761 --- /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 + +() => BrandingMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-sms-enrollment.tsx#L24) + +Hook to access branding and theme configuration. + +**Returns** + +[`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 + +**Example** + +```jsx +import { useBranding } from '@auth0/auth0-acul-react/login-id'; +function CustomTheme() { + const branding = useBranding(); +} +``` + + +() => ClientMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-sms-enrollment.tsx#L25) + +Hook to access Auth0 application (client) configuration. + +**Returns** + +[`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 + +**Example** + +```jsx +import { useClient } from '@auth0/auth0-acul-react/login-id'; +function AppInfo() { + const client = useClient(); +} +``` + + +() => OrganizationMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-sms-enrollment.tsx#L26) + +Hook to access organization context and settings. + +**Returns** + +[`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/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

No organization context

; + } +} +``` + + +() => PromptMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-sms-enrollment.tsx#L27) + +Hook to access prompt configuration and flow settings. + +**Returns** + +[`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 + +**Example** + +```jsx +import { usePrompt } from '@auth0/auth0-acul-react/login-id'; +function FlowInfo() { + const prompt = usePrompt(); +} +``` + + +() => ScreenMembersOnMfaSmsEnrollment}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-sms-enrollment.tsx#L28) + +Hook to access current screen information and metadata. + +**Returns** + +[`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 + +**Example** + +```jsx +import { useScreen } from '@auth0/auth0-acul-react/login-id'; +function ScreenDebug() { + const screen = useScreen(); +} +``` + + +() => TenantMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-sms-enrollment.tsx#L23) + +Hook to access tenant configuration and settings. + +**Returns** + +[`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/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(); +} +``` + + +() => TransactionMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-sms-enrollment.tsx#L29) + +Hook to access transaction state and authentication flow data. + +**Returns** + +[`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 + +**Example** + +```jsx +import { useTransaction } from '@auth0/auth0-acul-react/login-id'; +function TransactionInfo() { + const transaction = useTransaction(); +} +``` + + +() => UntrustedDataMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-sms-enrollment.tsx#L30) + +Hook to access untrusted data from URL parameters and form submissions. + +**Returns** + +[`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 + +**Example** + +```jsx +import { useUntrustedData } from '@auth0/auth0-acul-react/login-id'; +function PrefilledForm() { + const untrustedData = useUntrustedData(); +} +``` + + +() => UserMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-sms-enrollment.tsx#L22) + +Hook to access user information and profile data. + +**Returns** + +[`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 + +**Example** + +```jsx +import { useUser } from '@auth0/auth0-acul-react/login-id'; +function UserProfile() { + const user = useUser(); +} +``` + + + +## Functions + +void | Promise<void>}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-sms-enrollment.tsx#L36) + +**Parameters** + +**payload** + +**phone** + +`string` + +**captcha?** + +`string` + +**Returns** + +`void` \| `Promise`\<`void`\> + + +void | Promise<void>}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-sms-enrollment.tsx#L34) + +**Parameters** + +**payload?** + +[`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CustomOptions) + +**Returns** + +`void` \| `Promise`\<`void`\> + + +void | Promise<void>}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-sms-enrollment.tsx#L38) + +**Parameters** + +**payload?** + +[`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CustomOptions) + +**Returns** + +`void` \| `Promise`\<`void`\> + + +MfaSmsEnrollmentMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-sms-enrollment.tsx#L53) + +**Returns** + +[`MfaSmsEnrollmentMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaSmsEnrollmentMembers) + + + +## References + +useCurrentScreen} type='Hooks'/> + +useErrors} type='Hooks'/> + +useAuth0Themes} type='Hooks'/> + +UseErrorOptions} type='Types'/> + +UseErrorsResult} type='Types'/> + +ErrorsResult} type='Types'/> + +ErrorKind} 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..d1034104f --- /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 + +() => BrandingMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-sms-list.tsx#L25) + +Hook to access branding and theme configuration. + +**Returns** + +[`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 + +**Example** + +```jsx +import { useBranding } from '@auth0/auth0-acul-react/login-id'; +function CustomTheme() { + const branding = useBranding(); +} +``` + + +() => ClientMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-sms-list.tsx#L26) + +Hook to access Auth0 application (client) configuration. + +**Returns** + +[`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 + +**Example** + +```jsx +import { useClient } from '@auth0/auth0-acul-react/login-id'; +function AppInfo() { + const client = useClient(); +} +``` + + +() => OrganizationMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-sms-list.tsx#L27) + +Hook to access organization context and settings. + +**Returns** + +[`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/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

No organization context

; + } +} +``` + + +() => PromptMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-sms-list.tsx#L28) + +Hook to access prompt configuration and flow settings. + +**Returns** + +[`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 + +**Example** + +```jsx +import { usePrompt } from '@auth0/auth0-acul-react/login-id'; +function FlowInfo() { + const prompt = usePrompt(); +} +``` + + +() => ScreenMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-sms-list.tsx#L29) + +Hook to access current screen information and metadata. + +**Returns** + +[`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 + +**Example** + +```jsx +import { useScreen } from '@auth0/auth0-acul-react/login-id'; +function ScreenDebug() { + const screen = useScreen(); +} +``` + + +() => TenantMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-sms-list.tsx#L24) + +Hook to access tenant configuration and settings. + +**Returns** + +[`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/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(); +} +``` + + +() => TransactionMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-sms-list.tsx#L30) + +Hook to access transaction state and authentication flow data. + +**Returns** + +[`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 + +**Example** + +```jsx +import { useTransaction } from '@auth0/auth0-acul-react/login-id'; +function TransactionInfo() { + const transaction = useTransaction(); +} +``` + + +() => UntrustedDataMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-sms-list.tsx#L31) + +Hook to access untrusted data from URL parameters and form submissions. + +**Returns** + +[`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 + +**Example** + +```jsx +import { useUntrustedData } from '@auth0/auth0-acul-react/login-id'; +function PrefilledForm() { + const untrustedData = useUntrustedData(); +} +``` + + +() => UserMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-sms-list.tsx#L23) + +Hook to access user information and profile data. + +**Returns** + +[`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 + +**Example** + +```jsx +import { useUser } from '@auth0/auth0-acul-react/login-id'; +function UserProfile() { + const user = useUser(); +} +``` + + + +## Functions + +void | Promise<void>}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-sms-list.tsx#L37) + +**Parameters** + +**payload?** + +[`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CustomOptions) + +**Returns** + +`void` \| `Promise`\<`void`\> + + +void | Promise<void>}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-sms-list.tsx#L35) + +**Parameters** + +**payload?** + +[`MfaSmsListOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaSmsListOptions) + +**Returns** + +`void` \| `Promise`\<`void`\> + + +MfaSmsListMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-sms-list.tsx#L51) + +**Returns** + +[`MfaSmsListMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaSmsListMembers) + + + +## References + +useCurrentScreen} type='Hooks'/> + +useErrors} type='Hooks'/> + +useAuth0Themes} type='Hooks'/> + +UseErrorOptions} type='Types'/> + +UseErrorsResult} type='Types'/> + +ErrorsResult} type='Types'/> + +ErrorKind} 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..4ae0938e3 --- /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 + +() => BrandingMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-voice-challenge.tsx#L25) + +Hook to access branding and theme configuration. + +**Returns** + +[`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 + +**Example** + +```jsx +import { useBranding } from '@auth0/auth0-acul-react/login-id'; +function CustomTheme() { + const branding = useBranding(); +} +``` + + +() => ClientMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-voice-challenge.tsx#L26) + +Hook to access Auth0 application (client) configuration. + +**Returns** + +[`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 + +**Example** + +```jsx +import { useClient } from '@auth0/auth0-acul-react/login-id'; +function AppInfo() { + const client = useClient(); +} +``` + + +() => OrganizationMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-voice-challenge.tsx#L27) + +Hook to access organization context and settings. + +**Returns** + +[`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/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

No organization context

; + } +} +``` + + +() => PromptMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-voice-challenge.tsx#L28) + +Hook to access prompt configuration and flow settings. + +**Returns** + +[`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 + +**Example** + +```jsx +import { usePrompt } from '@auth0/auth0-acul-react/login-id'; +function FlowInfo() { + const prompt = usePrompt(); +} +``` + + +() => ScreenMembersOnMfaVoiceChallenge}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-voice-challenge.tsx#L29) + +Hook to access current screen information and metadata. + +**Returns** + +[`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 + +**Example** + +```jsx +import { useScreen } from '@auth0/auth0-acul-react/login-id'; +function ScreenDebug() { + const screen = useScreen(); +} +``` + + +() => TenantMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-voice-challenge.tsx#L24) + +Hook to access tenant configuration and settings. + +**Returns** + +[`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/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(); +} +``` + + +() => TransactionMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-voice-challenge.tsx#L30) + +Hook to access transaction state and authentication flow data. + +**Returns** + +[`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 + +**Example** + +```jsx +import { useTransaction } from '@auth0/auth0-acul-react/login-id'; +function TransactionInfo() { + const transaction = useTransaction(); +} +``` + + +() => UntrustedDataMembersOnMfaVoiceChallenge}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-voice-challenge.tsx#L31) + +Hook to access untrusted data from URL parameters and form submissions. + +**Returns** + +[`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 + +**Example** + +```jsx +import { useUntrustedData } from '@auth0/auth0-acul-react/login-id'; +function PrefilledForm() { + const untrustedData = useUntrustedData(); +} +``` + + +() => UserMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-voice-challenge.tsx#L23) + +Hook to access user information and profile data. + +**Returns** + +[`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 + +**Example** + +```jsx +import { useUser } from '@auth0/auth0-acul-react/login-id'; +function UserProfile() { + const user = useUser(); +} +``` + + + +## Functions + +void | Promise<void>}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-voice-challenge.tsx#L35) + +**Parameters** + +**payload** + +[`MfaVoiceChallengeContinueOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaVoiceChallengeContinueOptions) + +**Returns** + +`void` \| `Promise`\<`void`\> + + +void | Promise<void>}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-voice-challenge.tsx#L37) + +**Parameters** + +**payload?** + +[`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CustomOptions) + +**Returns** + +`void` \| `Promise`\<`void`\> + + +void | Promise<void>}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-voice-challenge.tsx#L39) + +**Parameters** + +**payload?** + +[`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CustomOptions) + +**Returns** + +`void` \| `Promise`\<`void`\> + + +void | Promise<void>}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-voice-challenge.tsx#L38) + +**Parameters** + +**payload?** + +[`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CustomOptions) + +**Returns** + +`void` \| `Promise`\<`void`\> + + +void | Promise<void>}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-voice-challenge.tsx#L40) + +**Parameters** + +**payload?** + +[`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CustomOptions) + +**Returns** + +`void` \| `Promise`\<`void`\> + + +MfaVoiceChallengeMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-voice-challenge.tsx#L58) + +**Returns** + +[`MfaVoiceChallengeMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaVoiceChallengeMembers) + + + +## References + +useResend} type='Hooks'/> + +useCurrentScreen} type='Hooks'/> + +useErrors} type='Hooks'/> + +useAuth0Themes} type='Hooks'/> + +UseErrorOptions} type='Types'/> + +UseErrorsResult} type='Types'/> + +ErrorsResult} type='Types'/> + +ErrorKind} 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..82137b55c --- /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 + +() => BrandingMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-voice-enrollment.tsx#L25) + +Hook to access branding and theme configuration. + +**Returns** + +[`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 + +**Example** + +```jsx +import { useBranding } from '@auth0/auth0-acul-react/login-id'; +function CustomTheme() { + const branding = useBranding(); +} +``` + + +() => ClientMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-voice-enrollment.tsx#L26) + +Hook to access Auth0 application (client) configuration. + +**Returns** + +[`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 + +**Example** + +```jsx +import { useClient } from '@auth0/auth0-acul-react/login-id'; +function AppInfo() { + const client = useClient(); +} +``` + + +() => OrganizationMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-voice-enrollment.tsx#L27) + +Hook to access organization context and settings. + +**Returns** + +[`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/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

No organization context

; + } +} +``` + + +() => PromptMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-voice-enrollment.tsx#L28) + +Hook to access prompt configuration and flow settings. + +**Returns** + +[`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 + +**Example** + +```jsx +import { usePrompt } from '@auth0/auth0-acul-react/login-id'; +function FlowInfo() { + const prompt = usePrompt(); +} +``` + + +() => ScreenMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-voice-enrollment.tsx#L29) + +Hook to access current screen information and metadata. + +**Returns** + +[`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 + +**Example** + +```jsx +import { useScreen } from '@auth0/auth0-acul-react/login-id'; +function ScreenDebug() { + const screen = useScreen(); +} +``` + + +() => TenantMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-voice-enrollment.tsx#L24) + +Hook to access tenant configuration and settings. + +**Returns** + +[`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/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(); +} +``` + + +() => TransactionMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-voice-enrollment.tsx#L30) + +Hook to access transaction state and authentication flow data. + +**Returns** + +[`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 + +**Example** + +```jsx +import { useTransaction } from '@auth0/auth0-acul-react/login-id'; +function TransactionInfo() { + const transaction = useTransaction(); +} +``` + + +() => UntrustedDataMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-voice-enrollment.tsx#L31) + +Hook to access untrusted data from URL parameters and form submissions. + +**Returns** + +[`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 + +**Example** + +```jsx +import { useUntrustedData } from '@auth0/auth0-acul-react/login-id'; +function PrefilledForm() { + const untrustedData = useUntrustedData(); +} +``` + + +() => UserMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-voice-enrollment.tsx#L23) + +Hook to access user information and profile data. + +**Returns** + +[`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 + +**Example** + +```jsx +import { useUser } from '@auth0/auth0-acul-react/login-id'; +function UserProfile() { + const user = useUser(); +} +``` + + + +## Functions + +void | Promise<void>}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-voice-enrollment.tsx#L35) + +**Parameters** + +**payload** + +[`MfaVoiceEnrollmentContinueOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaVoiceEnrollmentContinueOptions) + +**Returns** + +`void` \| `Promise`\<`void`\> + + +void | Promise<void>}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-voice-enrollment.tsx#L38) + +**Parameters** + +**payload?** + +[`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CustomOptions) + +**Returns** + +`void` \| `Promise`\<`void`\> + + +void | Promise<void>}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-voice-enrollment.tsx#L36) + +**Parameters** + +**payload?** + +[`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CustomOptions) + +**Returns** + +`void` \| `Promise`\<`void`\> + + +MfaVoiceEnrollmentMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-voice-enrollment.tsx#L53) + +**Returns** + +[`MfaVoiceEnrollmentMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaVoiceEnrollmentMembers) + + + +## References + +useCurrentScreen} type='Hooks'/> + +useErrors} type='Hooks'/> + +useAuth0Themes} type='Hooks'/> + +UseErrorOptions} type='Types'/> + +UseErrorsResult} type='Types'/> + +ErrorsResult} type='Types'/> + +ErrorKind} 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..6b1d25f6e --- /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 + +() => BrandingMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-webauthn-change-key-nickname.tsx#L24) + +Hook to access branding and theme configuration. + +**Returns** + +[`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 + +**Example** + +```jsx +import { useBranding } from '@auth0/auth0-acul-react/login-id'; +function CustomTheme() { + const branding = useBranding(); +} +``` + + +() => ClientMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-webauthn-change-key-nickname.tsx#L25) + +Hook to access Auth0 application (client) configuration. + +**Returns** + +[`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 + +**Example** + +```jsx +import { useClient } from '@auth0/auth0-acul-react/login-id'; +function AppInfo() { + const client = useClient(); +} +``` + + +() => OrganizationMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-webauthn-change-key-nickname.tsx#L26) + +Hook to access organization context and settings. + +**Returns** + +[`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/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

No organization context

; + } +} +``` + + +() => PromptMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-webauthn-change-key-nickname.tsx#L27) + +Hook to access prompt configuration and flow settings. + +**Returns** + +[`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 + +**Example** + +```jsx +import { usePrompt } from '@auth0/auth0-acul-react/login-id'; +function FlowInfo() { + const prompt = usePrompt(); +} +``` + + +() => ScreenMembersOnMfaWebAuthnChangeKeyNickname}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-webauthn-change-key-nickname.tsx#L28) + +Hook to access current screen information and metadata. + +**Returns** + +[`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 + +**Example** + +```jsx +import { useScreen } from '@auth0/auth0-acul-react/login-id'; +function ScreenDebug() { + const screen = useScreen(); +} +``` + + +() => TenantMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-webauthn-change-key-nickname.tsx#L23) + +Hook to access tenant configuration and settings. + +**Returns** + +[`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/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(); +} +``` + + +() => TransactionMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-webauthn-change-key-nickname.tsx#L29) + +Hook to access transaction state and authentication flow data. + +**Returns** + +[`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 + +**Example** + +```jsx +import { useTransaction } from '@auth0/auth0-acul-react/login-id'; +function TransactionInfo() { + const transaction = useTransaction(); +} +``` + + +() => UntrustedDataMembers}> +> **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/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. + +**Returns** + +[`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 + +**Example** + +```jsx +import { useUntrustedData } from '@auth0/auth0-acul-react/login-id'; +function PrefilledForm() { + const untrustedData = useUntrustedData(); +} +``` + + +() => UserMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-webauthn-change-key-nickname.tsx#L22) + +Hook to access user information and profile data. + +**Returns** + +[`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 + +**Example** + +```jsx +import { useUser } from '@auth0/auth0-acul-react/login-id'; +function UserProfile() { + const user = useUser(); +} +``` + + + +## Functions + +void | Promise<void>}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-webauthn-change-key-nickname.tsx#L34) + +**Parameters** + +**payload** + +[`MfaWebAuthnChangeKeyNicknameContinueOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaWebAuthnChangeKeyNicknameContinueOptions) + +**Returns** + +`void` \| `Promise`\<`void`\> + + +MfaWebAuthnChangeKeyNicknameMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-webauthn-change-key-nickname.tsx#L49) + +**Returns** + +[`MfaWebAuthnChangeKeyNicknameMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaWebAuthnChangeKeyNicknameMembers) + + + +## References + +useCurrentScreen} type='Hooks'/> + +useErrors} type='Hooks'/> + +useAuth0Themes} type='Hooks'/> + +UseErrorOptions} type='Types'/> + +UseErrorsResult} type='Types'/> + +ErrorsResult} type='Types'/> + +ErrorKind} 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..f95ec7317 --- /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 + +() => BrandingMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-webauthn-enrollment-success.tsx#L24) + +Hook to access branding and theme configuration. + +**Returns** + +[`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 + +**Example** + +```jsx +import { useBranding } from '@auth0/auth0-acul-react/login-id'; +function CustomTheme() { + const branding = useBranding(); +} +``` + + +() => ClientMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-webauthn-enrollment-success.tsx#L25) + +Hook to access Auth0 application (client) configuration. + +**Returns** + +[`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 + +**Example** + +```jsx +import { useClient } from '@auth0/auth0-acul-react/login-id'; +function AppInfo() { + const client = useClient(); +} +``` + + +() => OrganizationMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-webauthn-enrollment-success.tsx#L26) + +Hook to access organization context and settings. + +**Returns** + +[`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/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

No organization context

; + } +} +``` + + +() => PromptMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-webauthn-enrollment-success.tsx#L27) + +Hook to access prompt configuration and flow settings. + +**Returns** + +[`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 + +**Example** + +```jsx +import { usePrompt } from '@auth0/auth0-acul-react/login-id'; +function FlowInfo() { + const prompt = usePrompt(); +} +``` + + +() => ScreenMembersOnMfaWebAuthnEnrollmentSuccess}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-webauthn-enrollment-success.tsx#L28) + +Hook to access current screen information and metadata. + +**Returns** + +[`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 + +**Example** + +```jsx +import { useScreen } from '@auth0/auth0-acul-react/login-id'; +function ScreenDebug() { + const screen = useScreen(); +} +``` + + +() => TenantMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-webauthn-enrollment-success.tsx#L23) + +Hook to access tenant configuration and settings. + +**Returns** + +[`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/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(); +} +``` + + +() => TransactionMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-webauthn-enrollment-success.tsx#L29) + +Hook to access transaction state and authentication flow data. + +**Returns** + +[`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 + +**Example** + +```jsx +import { useTransaction } from '@auth0/auth0-acul-react/login-id'; +function TransactionInfo() { + const transaction = useTransaction(); +} +``` + + +() => UntrustedDataMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/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`](/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 + +**Example** + +```jsx +import { useUntrustedData } from '@auth0/auth0-acul-react/login-id'; +function PrefilledForm() { + const untrustedData = useUntrustedData(); +} +``` + + +() => UserMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-webauthn-enrollment-success.tsx#L22) + +Hook to access user information and profile data. + +**Returns** + +[`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 + +**Example** + +```jsx +import { useUser } from '@auth0/auth0-acul-react/login-id'; +function UserProfile() { + const user = useUser(); +} +``` + + + +## Functions + +void | Promise<void>}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-webauthn-enrollment-success.tsx#L34) + +**Parameters** + +**payload?** + +[`WebAuthnEnrollSuccessContinueOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/WebAuthnEnrollSuccessContinueOptions) + +**Returns** + +`void` \| `Promise`\<`void`\> + + +MfaWebAuthnEnrollmentSuccessMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-webauthn-enrollment-success.tsx#L48) + +**Returns** + +[`MfaWebAuthnEnrollmentSuccessMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaWebAuthnEnrollmentSuccessMembers) + + + +## References + +useCurrentScreen} type='Hooks'/> + +useErrors} type='Hooks'/> + +useAuth0Themes} type='Hooks'/> + +UseErrorOptions} type='Types'/> + +UseErrorsResult} type='Types'/> + +ErrorsResult} type='Types'/> + +ErrorKind} 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..44b08b344 --- /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 + +() => BrandingMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-webauthn-error.tsx#L24) + +Hook to access branding and theme configuration. + +**Returns** + +[`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 + +**Example** + +```jsx +import { useBranding } from '@auth0/auth0-acul-react/login-id'; +function CustomTheme() { + const branding = useBranding(); +} +``` + + +() => ClientMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-webauthn-error.tsx#L25) + +Hook to access Auth0 application (client) configuration. + +**Returns** + +[`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 + +**Example** + +```jsx +import { useClient } from '@auth0/auth0-acul-react/login-id'; +function AppInfo() { + const client = useClient(); +} +``` + + +() => OrganizationMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-webauthn-error.tsx#L26) + +Hook to access organization context and settings. + +**Returns** + +[`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/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

No organization context

; + } +} +``` + + +() => PromptMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-webauthn-error.tsx#L27) + +Hook to access prompt configuration and flow settings. + +**Returns** + +[`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 + +**Example** + +```jsx +import { usePrompt } from '@auth0/auth0-acul-react/login-id'; +function FlowInfo() { + const prompt = usePrompt(); +} +``` + + +() => ScreenMembersOnMfaWebAuthnError}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-webauthn-error.tsx#L28) + +Hook to access current screen information and metadata. + +**Returns** + +[`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 + +**Example** + +```jsx +import { useScreen } from '@auth0/auth0-acul-react/login-id'; +function ScreenDebug() { + const screen = useScreen(); +} +``` + + +() => TenantMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-webauthn-error.tsx#L23) + +Hook to access tenant configuration and settings. + +**Returns** + +[`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/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(); +} +``` + + +() => TransactionMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-webauthn-error.tsx#L29) + +Hook to access transaction state and authentication flow data. + +**Returns** + +[`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 + +**Example** + +```jsx +import { useTransaction } from '@auth0/auth0-acul-react/login-id'; +function TransactionInfo() { + const transaction = useTransaction(); +} +``` + + +() => UntrustedDataMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-webauthn-error.tsx#L30) + +Hook to access untrusted data from URL parameters and form submissions. + +**Returns** + +[`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 + +**Example** + +```jsx +import { useUntrustedData } from '@auth0/auth0-acul-react/login-id'; +function PrefilledForm() { + const untrustedData = useUntrustedData(); +} +``` + + +() => UserMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-webauthn-error.tsx#L22) + +Hook to access user information and profile data. + +**Returns** + +[`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 + +**Example** + +```jsx +import { useUser } from '@auth0/auth0-acul-react/login-id'; +function UserProfile() { + const user = useUser(); +} +``` + + + +## Functions + +void | Promise<void>}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-webauthn-error.tsx#L38) + +**Parameters** + +**payload?** + +[`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CustomOptions) + +**Returns** + +`void` \| `Promise`\<`void`\> + + +void | Promise<void>}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-webauthn-error.tsx#L34) + +**Parameters** + +**payload?** + +[`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CustomOptions) + +**Returns** + +`void` \| `Promise`\<`void`\> + + +void | Promise<void>}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-webauthn-error.tsx#L36) + +**Parameters** + +**payload?** + +[`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CustomOptions) + +**Returns** + +`void` \| `Promise`\<`void`\> + + +MfaWebAuthnErrorMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-webauthn-error.tsx#L52) + +**Returns** + +[`MfaWebAuthnErrorMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaWebAuthnErrorMembers) + + +void | Promise<void>}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-webauthn-error.tsx#L35) + +**Parameters** + +**payload?** + +[`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CustomOptions) + +**Returns** + +`void` \| `Promise`\<`void`\> + + + +## References + +useCurrentScreen} type='Hooks'/> + +useErrors} type='Hooks'/> + +useAuth0Themes} type='Hooks'/> + +UseErrorOptions} type='Types'/> + +UseErrorsResult} type='Types'/> + +ErrorsResult} type='Types'/> + +ErrorKind} 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..268e71179 --- /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 + +() => BrandingMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-webauthn-not-available-error.tsx#L24) + +Hook to access branding and theme configuration. + +**Returns** + +[`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 + +**Example** + +```jsx +import { useBranding } from '@auth0/auth0-acul-react/login-id'; +function CustomTheme() { + const branding = useBranding(); +} +``` + + +() => ClientMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-webauthn-not-available-error.tsx#L25) + +Hook to access Auth0 application (client) configuration. + +**Returns** + +[`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 + +**Example** + +```jsx +import { useClient } from '@auth0/auth0-acul-react/login-id'; +function AppInfo() { + const client = useClient(); +} +``` + + +() => OrganizationMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-webauthn-not-available-error.tsx#L26) + +Hook to access organization context and settings. + +**Returns** + +[`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/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

No organization context

; + } +} +``` + + +() => PromptMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-webauthn-not-available-error.tsx#L27) + +Hook to access prompt configuration and flow settings. + +**Returns** + +[`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 + +**Example** + +```jsx +import { usePrompt } from '@auth0/auth0-acul-react/login-id'; +function FlowInfo() { + const prompt = usePrompt(); +} +``` + + +() => ScreenMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-webauthn-not-available-error.tsx#L28) + +Hook to access current screen information and metadata. + +**Returns** + +[`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 + +**Example** + +```jsx +import { useScreen } from '@auth0/auth0-acul-react/login-id'; +function ScreenDebug() { + const screen = useScreen(); +} +``` + + +() => TenantMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-webauthn-not-available-error.tsx#L23) + +Hook to access tenant configuration and settings. + +**Returns** + +[`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/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(); +} +``` + + +() => TransactionMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-webauthn-not-available-error.tsx#L29) + +Hook to access transaction state and authentication flow data. + +**Returns** + +[`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 + +**Example** + +```jsx +import { useTransaction } from '@auth0/auth0-acul-react/login-id'; +function TransactionInfo() { + const transaction = useTransaction(); +} +``` + + +() => UntrustedDataMembers}> +> **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/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. + +**Returns** + +[`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 + +**Example** + +```jsx +import { useUntrustedData } from '@auth0/auth0-acul-react/login-id'; +function PrefilledForm() { + const untrustedData = useUntrustedData(); +} +``` + + +() => UserMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-webauthn-not-available-error.tsx#L22) + +Hook to access user information and profile data. + +**Returns** + +[`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 + +**Example** + +```jsx +import { useUser } from '@auth0/auth0-acul-react/login-id'; +function UserProfile() { + const user = useUser(); +} +``` + + + +## Functions + +void | Promise<void>}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-webauthn-not-available-error.tsx#L34) + +**Parameters** + +**payload?** + +[`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CustomOptions) + +**Returns** + +`void` \| `Promise`\<`void`\> + + +MfaWebAuthnNotAvailableErrorMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-webauthn-not-available-error.tsx#L49) + +**Returns** + +[`MfaWebAuthnNotAvailableErrorMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaWebAuthnNotAvailableErrorMembers) + + + +## References + +useCurrentScreen} type='Hooks'/> + +useErrors} type='Hooks'/> + +useAuth0Themes} type='Hooks'/> + +UseErrorOptions} type='Types'/> + +UseErrorsResult} type='Types'/> + +ErrorsResult} type='Types'/> + +ErrorKind} 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..fad0cf198 --- /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 + +() => BrandingMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-webauthn-platform-challenge.tsx#L26) + +Hook to access branding and theme configuration. + +**Returns** + +[`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 + +**Example** + +```jsx +import { useBranding } from '@auth0/auth0-acul-react/login-id'; +function CustomTheme() { + const branding = useBranding(); +} +``` + + +() => ClientMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-webauthn-platform-challenge.tsx#L27) + +Hook to access Auth0 application (client) configuration. + +**Returns** + +[`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 + +**Example** + +```jsx +import { useClient } from '@auth0/auth0-acul-react/login-id'; +function AppInfo() { + const client = useClient(); +} +``` + + +() => OrganizationMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-webauthn-platform-challenge.tsx#L28) + +Hook to access organization context and settings. + +**Returns** + +[`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/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

No organization context

; + } +} +``` + + +() => PromptMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-webauthn-platform-challenge.tsx#L29) + +Hook to access prompt configuration and flow settings. + +**Returns** + +[`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 + +**Example** + +```jsx +import { usePrompt } from '@auth0/auth0-acul-react/login-id'; +function FlowInfo() { + const prompt = usePrompt(); +} +``` + + +() => ScreenMembersOnMfaWebAuthnPlatformChallenge}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-webauthn-platform-challenge.tsx#L30) + +Hook to access current screen information and metadata. + +**Returns** + +[`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 + +**Example** + +```jsx +import { useScreen } from '@auth0/auth0-acul-react/login-id'; +function ScreenDebug() { + const screen = useScreen(); +} +``` + + +() => TenantMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-webauthn-platform-challenge.tsx#L25) + +Hook to access tenant configuration and settings. + +**Returns** + +[`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/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(); +} +``` + + +() => TransactionMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-webauthn-platform-challenge.tsx#L31) + +Hook to access transaction state and authentication flow data. + +**Returns** + +[`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 + +**Example** + +```jsx +import { useTransaction } from '@auth0/auth0-acul-react/login-id'; +function TransactionInfo() { + const transaction = useTransaction(); +} +``` + + +() => UntrustedDataMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/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`](/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 + +**Example** + +```jsx +import { useUntrustedData } from '@auth0/auth0-acul-react/login-id'; +function PrefilledForm() { + const untrustedData = useUntrustedData(); +} +``` + + +() => UserMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-webauthn-platform-challenge.tsx#L24) + +Hook to access user information and profile data. + +**Returns** + +[`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 + +**Example** + +```jsx +import { useUser } from '@auth0/auth0-acul-react/login-id'; +function UserProfile() { + const user = useUser(); +} +``` + + + +## Functions + +void | Promise<void>}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-webauthn-platform-challenge.tsx#L38) + +**Parameters** + +**options** + +[`MfaWebAuthnPlatformChallengeReportErrorOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaWebAuthnPlatformChallengeReportErrorOptions) + +**Returns** + +`void` \| `Promise`\<`void`\> + + +void | Promise<void>}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-webauthn-platform-challenge.tsx#L40) + +**Parameters** + +**options?** + +[`MfaWebAuthnPlatformChallengeTryAnotherMethodOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaWebAuthnPlatformChallengeTryAnotherMethodOptions) + +**Returns** + +`void` \| `Promise`\<`void`\> + + +MfaWebAuthnPlatformChallengeMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-webauthn-platform-challenge.tsx#L55) + +**Returns** + +[`MfaWebAuthnPlatformChallengeMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaWebAuthnPlatformChallengeMembers) + + +void | Promise<void>}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-webauthn-platform-challenge.tsx#L36) + +**Parameters** + +**options?** + +[`VerifyPlatformAuthenticatorOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/VerifyPlatformAuthenticatorOptions) + +**Returns** + +`void` \| `Promise`\<`void`\> + + + +## References + +useCurrentScreen} type='Hooks'/> + +useErrors} type='Hooks'/> + +useAuth0Themes} type='Hooks'/> + +UseErrorOptions} type='Types'/> + +UseErrorsResult} type='Types'/> + +ErrorsResult} type='Types'/> + +ErrorKind} 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..c89b90b9f --- /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 + +() => BrandingMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-webauthn-platform-enrollment.tsx#L28) + +Hook to access branding and theme configuration. + +**Returns** + +[`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 + +**Example** + +```jsx +import { useBranding } from '@auth0/auth0-acul-react/login-id'; +function CustomTheme() { + const branding = useBranding(); +} +``` + + +() => ClientMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-webauthn-platform-enrollment.tsx#L29) + +Hook to access Auth0 application (client) configuration. + +**Returns** + +[`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 + +**Example** + +```jsx +import { useClient } from '@auth0/auth0-acul-react/login-id'; +function AppInfo() { + const client = useClient(); +} +``` + + +() => OrganizationMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-webauthn-platform-enrollment.tsx#L30) + +Hook to access organization context and settings. + +**Returns** + +[`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/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

No organization context

; + } +} +``` + + +() => PromptMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-webauthn-platform-enrollment.tsx#L31) + +Hook to access prompt configuration and flow settings. + +**Returns** + +[`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 + +**Example** + +```jsx +import { usePrompt } from '@auth0/auth0-acul-react/login-id'; +function FlowInfo() { + const prompt = usePrompt(); +} +``` + + +() => ScreenMembersOnMfaWebAuthnPlatformEnrollment}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-webauthn-platform-enrollment.tsx#L32) + +Hook to access current screen information and metadata. + +**Returns** + +[`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 + +**Example** + +```jsx +import { useScreen } from '@auth0/auth0-acul-react/login-id'; +function ScreenDebug() { + const screen = useScreen(); +} +``` + + +() => TenantMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-webauthn-platform-enrollment.tsx#L27) + +Hook to access tenant configuration and settings. + +**Returns** + +[`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/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(); +} +``` + + +() => TransactionMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-webauthn-platform-enrollment.tsx#L33) + +Hook to access transaction state and authentication flow data. + +**Returns** + +[`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 + +**Example** + +```jsx +import { useTransaction } from '@auth0/auth0-acul-react/login-id'; +function TransactionInfo() { + const transaction = useTransaction(); +} +``` + + +() => UntrustedDataMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/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`](/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 + +**Example** + +```jsx +import { useUntrustedData } from '@auth0/auth0-acul-react/login-id'; +function PrefilledForm() { + const untrustedData = useUntrustedData(); +} +``` + + +() => UserMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-webauthn-platform-enrollment.tsx#L26) + +Hook to access user information and profile data. + +**Returns** + +[`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 + +**Example** + +```jsx +import { useUser } from '@auth0/auth0-acul-react/login-id'; +function UserProfile() { + const user = useUser(); +} +``` + + + +## Functions + +void | Promise<void>}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-webauthn-platform-enrollment.tsx#L44) + +**Parameters** + +**payload?** + +[`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CustomOptions) + +**Returns** + +`void` \| `Promise`\<`void`\> + + +void | Promise<void>}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-webauthn-platform-enrollment.tsx#L40) + +**Parameters** + +**payload** + +[`ReportBrowserErrorOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ReportBrowserErrorOptions) + +**Returns** + +`void` \| `Promise`\<`void`\> + + +void | Promise<void>}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-webauthn-platform-enrollment.tsx#L42) + +**Parameters** + +**payload?** + +[`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CustomOptions) + +**Returns** + +`void` \| `Promise`\<`void`\> + + +void | Promise<void>}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-webauthn-platform-enrollment.tsx#L38) + +**Parameters** + +**payload?** + +[`SubmitPasskeyCredentialOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/SubmitPasskeyCredentialOptions) + +**Returns** + +`void` \| `Promise`\<`void`\> + + +MfaWebAuthnPlatformEnrollmentMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-webauthn-platform-enrollment.tsx#L59) + +**Returns** + +[`MfaWebAuthnPlatformEnrollmentMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaWebAuthnPlatformEnrollmentMembers) + + + +## References + +useCurrentScreen} type='Hooks'/> + +useErrors} type='Hooks'/> + +useAuth0Themes} type='Hooks'/> + +UseErrorOptions} type='Types'/> + +UseErrorsResult} type='Types'/> + +ErrorsResult} type='Types'/> + +ErrorKind} 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..916f4ac1f --- /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 + +() => BrandingMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-webauthn-roaming-challenge.tsx#L26) + +Hook to access branding and theme configuration. + +**Returns** + +[`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 + +**Example** + +```jsx +import { useBranding } from '@auth0/auth0-acul-react/login-id'; +function CustomTheme() { + const branding = useBranding(); +} +``` + + +() => ClientMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-webauthn-roaming-challenge.tsx#L27) + +Hook to access Auth0 application (client) configuration. + +**Returns** + +[`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 + +**Example** + +```jsx +import { useClient } from '@auth0/auth0-acul-react/login-id'; +function AppInfo() { + const client = useClient(); +} +``` + + +() => OrganizationMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-webauthn-roaming-challenge.tsx#L28) + +Hook to access organization context and settings. + +**Returns** + +[`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/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

No organization context

; + } +} +``` + + +() => PromptMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-webauthn-roaming-challenge.tsx#L29) + +Hook to access prompt configuration and flow settings. + +**Returns** + +[`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 + +**Example** + +```jsx +import { usePrompt } from '@auth0/auth0-acul-react/login-id'; +function FlowInfo() { + const prompt = usePrompt(); +} +``` + + +() => ScreenMembersOnMfaWebAuthnRoamingChallenge}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-webauthn-roaming-challenge.tsx#L30) + +Hook to access current screen information and metadata. + +**Returns** + +[`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 + +**Example** + +```jsx +import { useScreen } from '@auth0/auth0-acul-react/login-id'; +function ScreenDebug() { + const screen = useScreen(); +} +``` + + +() => TenantMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-webauthn-roaming-challenge.tsx#L25) + +Hook to access tenant configuration and settings. + +**Returns** + +[`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/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(); +} +``` + + +() => TransactionMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-webauthn-roaming-challenge.tsx#L31) + +Hook to access transaction state and authentication flow data. + +**Returns** + +[`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 + +**Example** + +```jsx +import { useTransaction } from '@auth0/auth0-acul-react/login-id'; +function TransactionInfo() { + const transaction = useTransaction(); +} +``` + + +() => UntrustedDataMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/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`](/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 + +**Example** + +```jsx +import { useUntrustedData } from '@auth0/auth0-acul-react/login-id'; +function PrefilledForm() { + const untrustedData = useUntrustedData(); +} +``` + + +() => UserMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-webauthn-roaming-challenge.tsx#L24) + +Hook to access user information and profile data. + +**Returns** + +[`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 + +**Example** + +```jsx +import { useUser } from '@auth0/auth0-acul-react/login-id'; +function UserProfile() { + const user = useUser(); +} +``` + + + +## Functions + +void | Promise<void>}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-webauthn-roaming-challenge.tsx#L37) + +**Parameters** + +**options** + +[`MfaWebAuthnRoamingChallengeReportErrorOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaWebAuthnRoamingChallengeReportErrorOptions) + +**Returns** + +`void` \| `Promise`\<`void`\> + + +void | Promise<void>}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-webauthn-roaming-challenge.tsx#L39) + +**Parameters** + +**options?** + +[`MfaWebAuthnRoamingChallengeTryAnotherMethodOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaWebAuthnRoamingChallengeTryAnotherMethodOptions) + +**Returns** + +`void` \| `Promise`\<`void`\> + + +MfaWebAuthnRoamingChallengeMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-webauthn-roaming-challenge.tsx#L54) + +**Returns** + +[`MfaWebAuthnRoamingChallengeMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaWebAuthnRoamingChallengeMembers) + + +void | Promise<void>}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-webauthn-roaming-challenge.tsx#L36) + +**Parameters** + +**options?** + +[`VerifySecurityKeyOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/VerifySecurityKeyOptions) + +**Returns** + +`void` \| `Promise`\<`void`\> + + + +## References + +useCurrentScreen} type='Hooks'/> + +useErrors} type='Hooks'/> + +useAuth0Themes} type='Hooks'/> + +UseErrorOptions} type='Types'/> + +UseErrorsResult} type='Types'/> + +ErrorsResult} type='Types'/> + +ErrorKind} 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..d32389560 --- /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 + +() => BrandingMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-webauthn-roaming-enrollment.tsx#L26) + +Hook to access branding and theme configuration. + +**Returns** + +[`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 + +**Example** + +```jsx +import { useBranding } from '@auth0/auth0-acul-react/login-id'; +function CustomTheme() { + const branding = useBranding(); +} +``` + + +() => ClientMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-webauthn-roaming-enrollment.tsx#L27) + +Hook to access Auth0 application (client) configuration. + +**Returns** + +[`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 + +**Example** + +```jsx +import { useClient } from '@auth0/auth0-acul-react/login-id'; +function AppInfo() { + const client = useClient(); +} +``` + + +() => OrganizationMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-webauthn-roaming-enrollment.tsx#L28) + +Hook to access organization context and settings. + +**Returns** + +[`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/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

No organization context

; + } +} +``` + + +() => PromptMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-webauthn-roaming-enrollment.tsx#L29) + +Hook to access prompt configuration and flow settings. + +**Returns** + +[`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 + +**Example** + +```jsx +import { usePrompt } from '@auth0/auth0-acul-react/login-id'; +function FlowInfo() { + const prompt = usePrompt(); +} +``` + + +() => ScreenMembersOnMfaWebAuthnRoamingEnrollment}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-webauthn-roaming-enrollment.tsx#L30) + +Hook to access current screen information and metadata. + +**Returns** + +[`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 + +**Example** + +```jsx +import { useScreen } from '@auth0/auth0-acul-react/login-id'; +function ScreenDebug() { + const screen = useScreen(); +} +``` + + +() => TenantMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-webauthn-roaming-enrollment.tsx#L25) + +Hook to access tenant configuration and settings. + +**Returns** + +[`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/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(); +} +``` + + +() => TransactionMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-webauthn-roaming-enrollment.tsx#L31) + +Hook to access transaction state and authentication flow data. + +**Returns** + +[`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 + +**Example** + +```jsx +import { useTransaction } from '@auth0/auth0-acul-react/login-id'; +function TransactionInfo() { + const transaction = useTransaction(); +} +``` + + +() => UntrustedDataMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/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`](/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 + +**Example** + +```jsx +import { useUntrustedData } from '@auth0/auth0-acul-react/login-id'; +function PrefilledForm() { + const untrustedData = useUntrustedData(); +} +``` + + +() => UserMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-webauthn-roaming-enrollment.tsx#L24) + +Hook to access user information and profile data. + +**Returns** + +[`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 + +**Example** + +```jsx +import { useUser } from '@auth0/auth0-acul-react/login-id'; +function UserProfile() { + const user = useUser(); +} +``` + + + +## Functions + +void | Promise<void>}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-webauthn-roaming-enrollment.tsx#L36) + +**Parameters** + +**payload** + +[`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CustomOptions) + +**Returns** + +`void` \| `Promise`\<`void`\> + + +void | Promise<void>}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-webauthn-roaming-enrollment.tsx#L37) + +**Parameters** + +**payload** + +[`ShowErrorOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ShowErrorOptions) + +**Returns** + +`void` \| `Promise`\<`void`\> + + +void | Promise<void>}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-webauthn-roaming-enrollment.tsx#L38) + +**Parameters** + +**payload?** + +[`MfaWebAuthnRoamingEnrollmentTryAnotherMethodOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaWebAuthnRoamingEnrollmentTryAnotherMethodOptions) + +**Returns** + +`void` \| `Promise`\<`void`\> + + +MfaWebAuthnRoamingEnrollmentMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/mfa-webauthn-roaming-enrollment.tsx#L53) + +**Returns** + +[`MfaWebAuthnRoamingEnrollmentMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaWebAuthnRoamingEnrollmentMembers) + + + +## References + +useCurrentScreen} type='Hooks'/> + +useErrors} type='Hooks'/> + +useAuth0Themes} type='Hooks'/> + +UseErrorOptions} type='Types'/> + +UseErrorsResult} type='Types'/> + +ErrorsResult} type='Types'/> + +ErrorKind} 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..85355cefa --- /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 + +() => BrandingMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/organization-picker.tsx#L24) + +Hook to access branding and theme configuration. + +**Returns** + +[`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 + +**Example** + +```jsx +import { useBranding } from '@auth0/auth0-acul-react/login-id'; +function CustomTheme() { + const branding = useBranding(); +} +``` + + +() => ClientMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/organization-picker.tsx#L25) + +Hook to access Auth0 application (client) configuration. + +**Returns** + +[`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 + +**Example** + +```jsx +import { useClient } from '@auth0/auth0-acul-react/login-id'; +function AppInfo() { + const client = useClient(); +} +``` + + +() => OrganizationMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/organization-picker.tsx#L26) + +Hook to access organization context and settings. + +**Returns** + +[`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/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

No organization context

; + } +} +``` + + +() => PromptMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/organization-picker.tsx#L27) + +Hook to access prompt configuration and flow settings. + +**Returns** + +[`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 + +**Example** + +```jsx +import { usePrompt } from '@auth0/auth0-acul-react/login-id'; +function FlowInfo() { + const prompt = usePrompt(); +} +``` + + +() => ScreenMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/organization-picker.tsx#L28) + +Hook to access current screen information and metadata. + +**Returns** + +[`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 + +**Example** + +```jsx +import { useScreen } from '@auth0/auth0-acul-react/login-id'; +function ScreenDebug() { + const screen = useScreen(); +} +``` + + +() => TenantMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/organization-picker.tsx#L23) + +Hook to access tenant configuration and settings. + +**Returns** + +[`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/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(); +} +``` + + +() => TransactionMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/organization-picker.tsx#L29) + +Hook to access transaction state and authentication flow data. + +**Returns** + +[`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 + +**Example** + +```jsx +import { useTransaction } from '@auth0/auth0-acul-react/login-id'; +function TransactionInfo() { + const transaction = useTransaction(); +} +``` + + +() => UntrustedDataMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/organization-picker.tsx#L30) + +Hook to access untrusted data from URL parameters and form submissions. + +**Returns** + +[`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 + +**Example** + +```jsx +import { useUntrustedData } from '@auth0/auth0-acul-react/login-id'; +function PrefilledForm() { + const untrustedData = useUntrustedData(); +} +``` + + +() => UserMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/organization-picker.tsx#L22) + +Hook to access user information and profile data. + +**Returns** + +[`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 + +**Example** + +```jsx +import { useUser } from '@auth0/auth0-acul-react/login-id'; +function UserProfile() { + const user = useUser(); +} +``` + + + +## Functions + +void | Promise<void>}> +> **selectOrganization**(`payload`): `void` \| `Promise`\<`void`\> + +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** + +**payload** + +**organization** + +`string` + +**state** + +`string` + +**Returns** + +`void` \| `Promise`\<`void`\> + + +void | Promise<void>}> +> **skipOrganizationSelection**(`payload?`): `void` \| `Promise`\<`void`\> + +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** + +**payload?** + +[`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CustomOptions) + +**Returns** + +`void` \| `Promise`\<`void`\> + + +OrganizationPickerMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/organization-picker.tsx#L51) + +**Returns** + +[`OrganizationPickerMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationPickerMembers) + + + +## References + +useCurrentScreen} type='Hooks'/> + +useErrors} type='Hooks'/> + +useAuth0Themes} type='Hooks'/> + +UseErrorOptions} type='Types'/> + +UseErrorsResult} type='Types'/> + +ErrorsResult} type='Types'/> + +ErrorKind} 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..2a9efde6b --- /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 + +() => BrandingMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/organization-selection.tsx#L24) + +Hook to access branding and theme configuration. + +**Returns** + +[`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 + +**Example** + +```jsx +import { useBranding } from '@auth0/auth0-acul-react/login-id'; +function CustomTheme() { + const branding = useBranding(); +} +``` + + +() => ClientMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/organization-selection.tsx#L25) + +Hook to access Auth0 application (client) configuration. + +**Returns** + +[`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 + +**Example** + +```jsx +import { useClient } from '@auth0/auth0-acul-react/login-id'; +function AppInfo() { + const client = useClient(); +} +``` + + +() => OrganizationMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/organization-selection.tsx#L26) + +Hook to access organization context and settings. + +**Returns** + +[`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/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

No organization context

; + } +} +``` + + +() => PromptMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/organization-selection.tsx#L27) + +Hook to access prompt configuration and flow settings. + +**Returns** + +[`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 + +**Example** + +```jsx +import { usePrompt } from '@auth0/auth0-acul-react/login-id'; +function FlowInfo() { + const prompt = usePrompt(); +} +``` + + +() => ScreenMembersOnOrganizationSelection}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/organization-selection.tsx#L28) + +Hook to access current screen information and metadata. + +**Returns** + +[`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 + +**Example** + +```jsx +import { useScreen } from '@auth0/auth0-acul-react/login-id'; +function ScreenDebug() { + const screen = useScreen(); +} +``` + + +() => TenantMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/organization-selection.tsx#L23) + +Hook to access tenant configuration and settings. + +**Returns** + +[`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/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(); +} +``` + + +() => TransactionMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/organization-selection.tsx#L29) + +Hook to access transaction state and authentication flow data. + +**Returns** + +[`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 + +**Example** + +```jsx +import { useTransaction } from '@auth0/auth0-acul-react/login-id'; +function TransactionInfo() { + const transaction = useTransaction(); +} +``` + + +() => UntrustedDataMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/organization-selection.tsx#L30) + +Hook to access untrusted data from URL parameters and form submissions. + +**Returns** + +[`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 + +**Example** + +```jsx +import { useUntrustedData } from '@auth0/auth0-acul-react/login-id'; +function PrefilledForm() { + const untrustedData = useUntrustedData(); +} +``` + + +() => UserMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/organization-selection.tsx#L22) + +Hook to access user information and profile data. + +**Returns** + +[`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 + +**Example** + +```jsx +import { useUser } from '@auth0/auth0-acul-react/login-id'; +function UserProfile() { + const user = useUser(); +} +``` + + + +## Functions + +void | Promise<void>}> +> **continueWithOrganizationName**(`payload`): `void` \| `Promise`\<`void`\> + +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** + +**payload** + +[`ContinueWithOrganizationNameOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ContinueWithOrganizationNameOptions) + +**Returns** + +`void` \| `Promise`\<`void`\> + + +OrganizationSelectionMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/organization-selection.tsx#L49) + +**Returns** + +[`OrganizationSelectionMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationSelectionMembers) + + + +## References + +useCurrentScreen} type='Hooks'/> + +useErrors} type='Hooks'/> + +useAuth0Themes} type='Hooks'/> + +UseErrorOptions} type='Types'/> + +UseErrorsResult} type='Types'/> + +ErrorsResult} type='Types'/> + +ErrorKind} 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..0f33796ae --- /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 + +() => BrandingMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/passkey-enrollment-local.tsx#L25) + +Hook to access branding and theme configuration. + +**Returns** + +[`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 + +**Example** + +```jsx +import { useBranding } from '@auth0/auth0-acul-react/login-id'; +function CustomTheme() { + const branding = useBranding(); +} +``` + + +() => ClientMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/passkey-enrollment-local.tsx#L26) + +Hook to access Auth0 application (client) configuration. + +**Returns** + +[`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 + +**Example** + +```jsx +import { useClient } from '@auth0/auth0-acul-react/login-id'; +function AppInfo() { + const client = useClient(); +} +``` + + +() => OrganizationMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/passkey-enrollment-local.tsx#L27) + +Hook to access organization context and settings. + +**Returns** + +[`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/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

No organization context

; + } +} +``` + + +() => PromptMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/passkey-enrollment-local.tsx#L28) + +Hook to access prompt configuration and flow settings. + +**Returns** + +[`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 + +**Example** + +```jsx +import { usePrompt } from '@auth0/auth0-acul-react/login-id'; +function FlowInfo() { + const prompt = usePrompt(); +} +``` + + +() => ScreenMembersOnPasskeyEnrollmentLocal}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/passkey-enrollment-local.tsx#L29) + +Hook to access current screen information and metadata. + +**Returns** + +[`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 + +**Example** + +```jsx +import { useScreen } from '@auth0/auth0-acul-react/login-id'; +function ScreenDebug() { + const screen = useScreen(); +} +``` + + +() => TenantMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/passkey-enrollment-local.tsx#L24) + +Hook to access tenant configuration and settings. + +**Returns** + +[`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/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(); +} +``` + + +() => TransactionMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/passkey-enrollment-local.tsx#L30) + +Hook to access transaction state and authentication flow data. + +**Returns** + +[`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 + +**Example** + +```jsx +import { useTransaction } from '@auth0/auth0-acul-react/login-id'; +function TransactionInfo() { + const transaction = useTransaction(); +} +``` + + +() => UntrustedDataMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/passkey-enrollment-local.tsx#L31) + +Hook to access untrusted data from URL parameters and form submissions. + +**Returns** + +[`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 + +**Example** + +```jsx +import { useUntrustedData } from '@auth0/auth0-acul-react/login-id'; +function PrefilledForm() { + const untrustedData = useUntrustedData(); +} +``` + + +() => UserMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/passkey-enrollment-local.tsx#L23) + +Hook to access user information and profile data. + +**Returns** + +[`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 + +**Example** + +```jsx +import { useUser } from '@auth0/auth0-acul-react/login-id'; +function UserProfile() { + const user = useUser(); +} +``` + + + +## Functions + +void | Promise<void>}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/passkey-enrollment-local.tsx#L37) + +**Parameters** + +**payload** + +[`AbortEnrollmentOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/AbortEnrollmentOptions) + +**Returns** + +`void` \| `Promise`\<`void`\> + + +void | Promise<void>}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/passkey-enrollment-local.tsx#L35) + +**Parameters** + +**payload?** + +[`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CustomOptions) + +**Returns** + +`void` \| `Promise`\<`void`\> + + +PasskeyEnrollmentLocalMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/passkey-enrollment-local.tsx#L52) + +**Returns** + +[`PasskeyEnrollmentLocalMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PasskeyEnrollmentLocalMembers) + + + +## References + +useCurrentScreen} type='Hooks'/> + +useErrors} type='Hooks'/> + +useAuth0Themes} type='Hooks'/> + +UseErrorOptions} type='Types'/> + +UseErrorsResult} type='Types'/> + +ErrorsResult} type='Types'/> + +ErrorKind} 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..928ff9e08 --- /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 + +() => BrandingMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/passkey-enrollment.tsx#L24) + +Hook to access branding and theme configuration. + +**Returns** + +[`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 + +**Example** + +```jsx +import { useBranding } from '@auth0/auth0-acul-react/login-id'; +function CustomTheme() { + const branding = useBranding(); +} +``` + + +() => ClientMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/passkey-enrollment.tsx#L25) + +Hook to access Auth0 application (client) configuration. + +**Returns** + +[`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 + +**Example** + +```jsx +import { useClient } from '@auth0/auth0-acul-react/login-id'; +function AppInfo() { + const client = useClient(); +} +``` + + +() => OrganizationMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/passkey-enrollment.tsx#L26) + +Hook to access organization context and settings. + +**Returns** + +[`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/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

No organization context

; + } +} +``` + + +() => PromptMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/passkey-enrollment.tsx#L27) + +Hook to access prompt configuration and flow settings. + +**Returns** + +[`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 + +**Example** + +```jsx +import { usePrompt } from '@auth0/auth0-acul-react/login-id'; +function FlowInfo() { + const prompt = usePrompt(); +} +``` + + +() => ScreenMembersOnPasskeyEnrollment}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/passkey-enrollment.tsx#L28) + +Hook to access current screen information and metadata. + +**Returns** + +[`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 + +**Example** + +```jsx +import { useScreen } from '@auth0/auth0-acul-react/login-id'; +function ScreenDebug() { + const screen = useScreen(); +} +``` + + +() => TenantMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/passkey-enrollment.tsx#L23) + +Hook to access tenant configuration and settings. + +**Returns** + +[`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/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(); +} +``` + + +() => TransactionMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/passkey-enrollment.tsx#L29) + +Hook to access transaction state and authentication flow data. + +**Returns** + +[`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 + +**Example** + +```jsx +import { useTransaction } from '@auth0/auth0-acul-react/login-id'; +function TransactionInfo() { + const transaction = useTransaction(); +} +``` + + +() => UntrustedDataMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/passkey-enrollment.tsx#L30) + +Hook to access untrusted data from URL parameters and form submissions. + +**Returns** + +[`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 + +**Example** + +```jsx +import { useUntrustedData } from '@auth0/auth0-acul-react/login-id'; +function PrefilledForm() { + const untrustedData = useUntrustedData(); +} +``` + + +() => UserMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/passkey-enrollment.tsx#L22) + +Hook to access user information and profile data. + +**Returns** + +[`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 + +**Example** + +```jsx +import { useUser } from '@auth0/auth0-acul-react/login-id'; +function UserProfile() { + const user = useUser(); +} +``` + + + +## Functions + +void | Promise<void>}> +> **abortPasskeyEnrollment**(`payload?`): `void` \| `Promise`\<`void`\> + +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** + +**payload?** + +[`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CustomOptions) + +**Returns** + +`void` \| `Promise`\<`void`\> + + +void | Promise<void>}> +> **continuePasskeyEnrollment**(`payload?`): `void` \| `Promise`\<`void`\> + +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** + +**payload?** + +[`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CustomOptions) + +**Returns** + +`void` \| `Promise`\<`void`\> + + +PasskeyEnrollmentMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/passkey-enrollment.tsx#L51) + +**Returns** + +[`PasskeyEnrollmentMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PasskeyEnrollmentMembers) + + + +## References + +useCurrentScreen} type='Hooks'/> + +useErrors} type='Hooks'/> + +useAuth0Themes} type='Hooks'/> + +UseErrorOptions} type='Types'/> + +UseErrorsResult} type='Types'/> + +ErrorsResult} type='Types'/> + +ErrorKind} 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..618026aad --- /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 + +() => BrandingMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/phone-identifier-challenge.tsx#L25) + +Hook to access branding and theme configuration. + +**Returns** + +[`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 + +**Example** + +```jsx +import { useBranding } from '@auth0/auth0-acul-react/login-id'; +function CustomTheme() { + const branding = useBranding(); +} +``` + + +() => ClientMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/phone-identifier-challenge.tsx#L26) + +Hook to access Auth0 application (client) configuration. + +**Returns** + +[`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 + +**Example** + +```jsx +import { useClient } from '@auth0/auth0-acul-react/login-id'; +function AppInfo() { + const client = useClient(); +} +``` + + +() => OrganizationMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/phone-identifier-challenge.tsx#L27) + +Hook to access organization context and settings. + +**Returns** + +[`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/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

No organization context

; + } +} +``` + + +() => PromptMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/phone-identifier-challenge.tsx#L28) + +Hook to access prompt configuration and flow settings. + +**Returns** + +[`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 + +**Example** + +```jsx +import { usePrompt } from '@auth0/auth0-acul-react/login-id'; +function FlowInfo() { + const prompt = usePrompt(); +} +``` + + +() => ScreenMembersOnPhoneIdentifierChallenge}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/phone-identifier-challenge.tsx#L29) + +Hook to access current screen information and metadata. + +**Returns** + +[`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 + +**Example** + +```jsx +import { useScreen } from '@auth0/auth0-acul-react/login-id'; +function ScreenDebug() { + const screen = useScreen(); +} +``` + + +() => TenantMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/phone-identifier-challenge.tsx#L24) + +Hook to access tenant configuration and settings. + +**Returns** + +[`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/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(); +} +``` + + +() => TransactionMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/phone-identifier-challenge.tsx#L30) + +Hook to access transaction state and authentication flow data. + +**Returns** + +[`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 + +**Example** + +```jsx +import { useTransaction } from '@auth0/auth0-acul-react/login-id'; +function TransactionInfo() { + const transaction = useTransaction(); +} +``` + + +() => UntrustedDataMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/phone-identifier-challenge.tsx#L31) + +Hook to access untrusted data from URL parameters and form submissions. + +**Returns** + +[`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 + +**Example** + +```jsx +import { useUntrustedData } from '@auth0/auth0-acul-react/login-id'; +function PrefilledForm() { + const untrustedData = useUntrustedData(); +} +``` + + +() => UserMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/phone-identifier-challenge.tsx#L23) + +Hook to access user information and profile data. + +**Returns** + +[`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 + +**Example** + +```jsx +import { useUser } from '@auth0/auth0-acul-react/login-id'; +function UserProfile() { + const user = useUser(); +} +``` + + + +## Functions + +void | Promise<void>}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/phone-identifier-challenge.tsx#L37) + +**Parameters** + +**payload?** + +[`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CustomOptions) + +**Returns** + +`void` \| `Promise`\<`void`\> + + +void | Promise<void>}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/phone-identifier-challenge.tsx#L38) + +**Parameters** + +**payload?** + +[`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CustomOptions) + +**Returns** + +`void` \| `Promise`\<`void`\> + + +void | Promise<void>}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/phone-identifier-challenge.tsx#L35) + +**Parameters** + +**payload** + +[`PhoneChallengeOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PhoneChallengeOptions) + +**Returns** + +`void` \| `Promise`\<`void`\> + + +void | Promise<void>}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/phone-identifier-challenge.tsx#L42) + +**Parameters** + +**payload?** + +[`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CustomOptions) + +**Returns** + +`void` \| `Promise`\<`void`\> + + +void | Promise<void>}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/phone-identifier-challenge.tsx#L40) + +**Parameters** + +**payload?** + +[`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CustomOptions) + +**Returns** + +`void` \| `Promise`\<`void`\> + + +PhoneIdentifierChallengeMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/phone-identifier-challenge.tsx#L59) + +**Returns** + +[`PhoneIdentifierChallengeMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PhoneIdentifierChallengeMembers) + + + +## References + +useResend} type='Hooks'/> + +useCurrentScreen} type='Hooks'/> + +useErrors} type='Hooks'/> + +useAuth0Themes} type='Hooks'/> + +UseErrorOptions} type='Types'/> + +UseErrorsResult} type='Types'/> + +ErrorsResult} type='Types'/> + +ErrorKind} 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..5bc60e0ed --- /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 + +() => BrandingMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/phone-identifier-enrollment.tsx#L25) + +Hook to access branding and theme configuration. + +**Returns** + +[`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 + +**Example** + +```jsx +import { useBranding } from '@auth0/auth0-acul-react/login-id'; +function CustomTheme() { + const branding = useBranding(); +} +``` + + +() => ClientMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/phone-identifier-enrollment.tsx#L26) + +Hook to access Auth0 application (client) configuration. + +**Returns** + +[`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 + +**Example** + +```jsx +import { useClient } from '@auth0/auth0-acul-react/login-id'; +function AppInfo() { + const client = useClient(); +} +``` + + +() => OrganizationMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/phone-identifier-enrollment.tsx#L27) + +Hook to access organization context and settings. + +**Returns** + +[`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/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

No organization context

; + } +} +``` + + +() => PromptMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/phone-identifier-enrollment.tsx#L28) + +Hook to access prompt configuration and flow settings. + +**Returns** + +[`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 + +**Example** + +```jsx +import { usePrompt } from '@auth0/auth0-acul-react/login-id'; +function FlowInfo() { + const prompt = usePrompt(); +} +``` + + +() => ScreenMembersOnPhoneIdentifierEnrollment}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/phone-identifier-enrollment.tsx#L29) + +Hook to access current screen information and metadata. + +**Returns** + +[`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 + +**Example** + +```jsx +import { useScreen } from '@auth0/auth0-acul-react/login-id'; +function ScreenDebug() { + const screen = useScreen(); +} +``` + + +() => TenantMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/phone-identifier-enrollment.tsx#L24) + +Hook to access tenant configuration and settings. + +**Returns** + +[`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/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(); +} +``` + + +() => TransactionMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/phone-identifier-enrollment.tsx#L30) + +Hook to access transaction state and authentication flow data. + +**Returns** + +[`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 + +**Example** + +```jsx +import { useTransaction } from '@auth0/auth0-acul-react/login-id'; +function TransactionInfo() { + const transaction = useTransaction(); +} +``` + + +() => UntrustedDataMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/phone-identifier-enrollment.tsx#L31) + +Hook to access untrusted data from URL parameters and form submissions. + +**Returns** + +[`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 + +**Example** + +```jsx +import { useUntrustedData } from '@auth0/auth0-acul-react/login-id'; +function PrefilledForm() { + const untrustedData = useUntrustedData(); +} +``` + + +() => UserMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/phone-identifier-enrollment.tsx#L23) + +Hook to access user information and profile data. + +**Returns** + +[`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 + +**Example** + +```jsx +import { useUser } from '@auth0/auth0-acul-react/login-id'; +function UserProfile() { + const user = useUser(); +} +``` + + + +## Functions + +void | Promise<void>}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/phone-identifier-enrollment.tsx#L35) + +**Parameters** + +**payload** + +[`PhoneEnrollmentOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PhoneEnrollmentOptions) + +**Returns** + +`void` \| `Promise`\<`void`\> + + +void | Promise<void>}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/phone-identifier-enrollment.tsx#L37) + +**Parameters** + +**payload?** + +[`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CustomOptions) + +**Returns** + +`void` \| `Promise`\<`void`\> + + +PhoneIdentifierEnrollmentMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/phone-identifier-enrollment.tsx#L52) + +**Returns** + +[`PhoneIdentifierEnrollmentMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PhoneIdentifierEnrollmentMembers) + + + +## References + +useCurrentScreen} type='Hooks'/> + +useErrors} type='Hooks'/> + +useAuth0Themes} type='Hooks'/> + +UseErrorOptions} type='Types'/> + +UseErrorsResult} type='Types'/> + +ErrorsResult} type='Types'/> + +ErrorKind} 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..858ab453d --- /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 + +() => BrandingMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/redeem-ticket.tsx#L21) + +Hook to access branding and theme configuration. + +**Returns** + +[`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 + +**Example** + +```jsx +import { useBranding } from '@auth0/auth0-acul-react/login-id'; +function CustomTheme() { + const branding = useBranding(); +} +``` + + +() => ClientMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/redeem-ticket.tsx#L22) + +Hook to access Auth0 application (client) configuration. + +**Returns** + +[`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 + +**Example** + +```jsx +import { useClient } from '@auth0/auth0-acul-react/login-id'; +function AppInfo() { + const client = useClient(); +} +``` + + +() => OrganizationMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/redeem-ticket.tsx#L23) + +Hook to access organization context and settings. + +**Returns** + +[`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/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

No organization context

; + } +} +``` + + +() => PromptMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/redeem-ticket.tsx#L24) + +Hook to access prompt configuration and flow settings. + +**Returns** + +[`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 + +**Example** + +```jsx +import { usePrompt } from '@auth0/auth0-acul-react/login-id'; +function FlowInfo() { + const prompt = usePrompt(); +} +``` + + +() => ScreenMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/redeem-ticket.tsx#L25) + +Hook to access current screen information and metadata. + +**Returns** + +[`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 + +**Example** + +```jsx +import { useScreen } from '@auth0/auth0-acul-react/login-id'; +function ScreenDebug() { + const screen = useScreen(); +} +``` + + +() => TenantMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/redeem-ticket.tsx#L20) + +Hook to access tenant configuration and settings. + +**Returns** + +[`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/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(); +} +``` + + +() => TransactionMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/redeem-ticket.tsx#L26) + +Hook to access transaction state and authentication flow data. + +**Returns** + +[`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 + +**Example** + +```jsx +import { useTransaction } from '@auth0/auth0-acul-react/login-id'; +function TransactionInfo() { + const transaction = useTransaction(); +} +``` + + +() => UntrustedDataMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/redeem-ticket.tsx#L27) + +Hook to access untrusted data from URL parameters and form submissions. + +**Returns** + +[`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 + +**Example** + +```jsx +import { useUntrustedData } from '@auth0/auth0-acul-react/login-id'; +function PrefilledForm() { + const untrustedData = useUntrustedData(); +} +``` + + +() => UserMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/redeem-ticket.tsx#L19) + +Hook to access user information and profile data. + +**Returns** + +[`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 + +**Example** + +```jsx +import { useUser } from '@auth0/auth0-acul-react/login-id'; +function UserProfile() { + const user = useUser(); +} +``` + + + +## Functions + +void | Promise<void>}> +> **continueMethod**(`payload?`): `void` \| `Promise`\<`void`\> + +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** + +**payload?** + +[`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CustomOptions) + +**Returns** + +`void` \| `Promise`\<`void`\> + + +RedeemTicketMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/redeem-ticket.tsx#L45) + +**Returns** + +[`RedeemTicketMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/RedeemTicketMembers) + + + +## References + +useCurrentScreen} type='Hooks'/> + +useErrors} type='Hooks'/> + +useAuth0Themes} type='Hooks'/> + +UseErrorOptions} type='Types'/> + +UseErrorsResult} type='Types'/> + +ErrorsResult} type='Types'/> + +ErrorKind} 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..c7e999ee0 --- /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 + +() => BrandingMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/reset-password-email.tsx#L24) + +Hook to access branding and theme configuration. + +**Returns** + +[`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 + +**Example** + +```jsx +import { useBranding } from '@auth0/auth0-acul-react/login-id'; +function CustomTheme() { + const branding = useBranding(); +} +``` + + +() => ClientMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/reset-password-email.tsx#L25) + +Hook to access Auth0 application (client) configuration. + +**Returns** + +[`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 + +**Example** + +```jsx +import { useClient } from '@auth0/auth0-acul-react/login-id'; +function AppInfo() { + const client = useClient(); +} +``` + + +() => OrganizationMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/reset-password-email.tsx#L26) + +Hook to access organization context and settings. + +**Returns** + +[`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/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

No organization context

; + } +} +``` + + +() => PromptMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/reset-password-email.tsx#L27) + +Hook to access prompt configuration and flow settings. + +**Returns** + +[`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 + +**Example** + +```jsx +import { usePrompt } from '@auth0/auth0-acul-react/login-id'; +function FlowInfo() { + const prompt = usePrompt(); +} +``` + + +() => ScreenMembersOnResetPasswordEmail}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/reset-password-email.tsx#L28) + +Hook to access current screen information and metadata. + +**Returns** + +[`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 + +**Example** + +```jsx +import { useScreen } from '@auth0/auth0-acul-react/login-id'; +function ScreenDebug() { + const screen = useScreen(); +} +``` + + +() => TenantMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/reset-password-email.tsx#L23) + +Hook to access tenant configuration and settings. + +**Returns** + +[`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/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(); +} +``` + + +() => TransactionMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/reset-password-email.tsx#L29) + +Hook to access transaction state and authentication flow data. + +**Returns** + +[`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 + +**Example** + +```jsx +import { useTransaction } from '@auth0/auth0-acul-react/login-id'; +function TransactionInfo() { + const transaction = useTransaction(); +} +``` + + +() => UntrustedDataMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/reset-password-email.tsx#L30) + +Hook to access untrusted data from URL parameters and form submissions. + +**Returns** + +[`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 + +**Example** + +```jsx +import { useUntrustedData } from '@auth0/auth0-acul-react/login-id'; +function PrefilledForm() { + const untrustedData = useUntrustedData(); +} +``` + + +() => UserMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/reset-password-email.tsx#L22) + +Hook to access user information and profile data. + +**Returns** + +[`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 + +**Example** + +```jsx +import { useUser } from '@auth0/auth0-acul-react/login-id'; +function UserProfile() { + const user = useUser(); +} +``` + + + +## Functions + +void | Promise<void>}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/reset-password-email.tsx#L34) + +**Parameters** + +**payload?** + +[`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CustomOptions) + +**Returns** + +`void` \| `Promise`\<`void`\> + + +ResetPasswordEmailMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/reset-password-email.tsx#L48) + +**Returns** + +[`ResetPasswordEmailMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResetPasswordEmailMembers) + + + +## References + +useCurrentScreen} type='Hooks'/> + +useErrors} type='Hooks'/> + +useAuth0Themes} type='Hooks'/> + +UseErrorOptions} type='Types'/> + +UseErrorsResult} type='Types'/> + +ErrorsResult} type='Types'/> + +ErrorKind} 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..59d32ce52 --- /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 + +() => BrandingMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/reset-password-error.tsx#L17) + +Hook to access branding and theme configuration. + +**Returns** + +[`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 + +**Example** + +```jsx +import { useBranding } from '@auth0/auth0-acul-react/login-id'; +function CustomTheme() { + const branding = useBranding(); +} +``` + + +() => ClientMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/reset-password-error.tsx#L18) + +Hook to access Auth0 application (client) configuration. + +**Returns** + +[`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 + +**Example** + +```jsx +import { useClient } from '@auth0/auth0-acul-react/login-id'; +function AppInfo() { + const client = useClient(); +} +``` + + +() => OrganizationMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/reset-password-error.tsx#L19) + +Hook to access organization context and settings. + +**Returns** + +[`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/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

No organization context

; + } +} +``` + + +() => PromptMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/reset-password-error.tsx#L20) + +Hook to access prompt configuration and flow settings. + +**Returns** + +[`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 + +**Example** + +```jsx +import { usePrompt } from '@auth0/auth0-acul-react/login-id'; +function FlowInfo() { + const prompt = usePrompt(); +} +``` + + +() => ScreenMembersOnResetPasswordError}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/reset-password-error.tsx#L21) + +Hook to access current screen information and metadata. + +**Returns** + +[`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 + +**Example** + +```jsx +import { useScreen } from '@auth0/auth0-acul-react/login-id'; +function ScreenDebug() { + const screen = useScreen(); +} +``` + + +() => TenantMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/reset-password-error.tsx#L16) + +Hook to access tenant configuration and settings. + +**Returns** + +[`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/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(); +} +``` + + +() => TransactionMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/reset-password-error.tsx#L22) + +Hook to access transaction state and authentication flow data. + +**Returns** + +[`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 + +**Example** + +```jsx +import { useTransaction } from '@auth0/auth0-acul-react/login-id'; +function TransactionInfo() { + const transaction = useTransaction(); +} +``` + + +() => UntrustedDataMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/reset-password-error.tsx#L23) + +Hook to access untrusted data from URL parameters and form submissions. + +**Returns** + +[`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 + +**Example** + +```jsx +import { useUntrustedData } from '@auth0/auth0-acul-react/login-id'; +function PrefilledForm() { + const untrustedData = useUntrustedData(); +} +``` + + +() => UserMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/reset-password-error.tsx#L15) + +Hook to access user information and profile data. + +**Returns** + +[`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 + +**Example** + +```jsx +import { useUser } from '@auth0/auth0-acul-react/login-id'; +function UserProfile() { + const user = useUser(); +} +``` + + + +## Functions + +ResetPasswordErrorMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/reset-password-error.tsx#L38) + +**Returns** + +[`ResetPasswordErrorMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResetPasswordErrorMembers) + + + +## References + +useCurrentScreen} type='Hooks'/> + +useErrors} type='Hooks'/> + +useAuth0Themes} type='Hooks'/> + +UseErrorOptions} type='Types'/> + +UseErrorsResult} type='Types'/> + +ErrorsResult} type='Types'/> + +ErrorKind} 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..fe2cbbde4 --- /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 + +() => BrandingMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/reset-password-mfa-email-challenge.tsx#L28) + +Hook to access branding and theme configuration. + +**Returns** + +[`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 + +**Example** + +```jsx +import { useBranding } from '@auth0/auth0-acul-react/login-id'; +function CustomTheme() { + const branding = useBranding(); +} +``` + + +() => ClientMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/reset-password-mfa-email-challenge.tsx#L29) + +Hook to access Auth0 application (client) configuration. + +**Returns** + +[`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 + +**Example** + +```jsx +import { useClient } from '@auth0/auth0-acul-react/login-id'; +function AppInfo() { + const client = useClient(); +} +``` + + +() => OrganizationMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/reset-password-mfa-email-challenge.tsx#L30) + +Hook to access organization context and settings. + +**Returns** + +[`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/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

No organization context

; + } +} +``` + + +() => PromptMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/reset-password-mfa-email-challenge.tsx#L31) + +Hook to access prompt configuration and flow settings. + +**Returns** + +[`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 + +**Example** + +```jsx +import { usePrompt } from '@auth0/auth0-acul-react/login-id'; +function FlowInfo() { + const prompt = usePrompt(); +} +``` + + +() => ScreenMembersOnResetPasswordMfaEmailChallenge}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/reset-password-mfa-email-challenge.tsx#L32) + +Hook to access current screen information and metadata. + +**Returns** + +[`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 + +**Example** + +```jsx +import { useScreen } from '@auth0/auth0-acul-react/login-id'; +function ScreenDebug() { + const screen = useScreen(); +} +``` + + +() => TenantMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/reset-password-mfa-email-challenge.tsx#L27) + +Hook to access tenant configuration and settings. + +**Returns** + +[`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/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(); +} +``` + + +() => TransactionMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/reset-password-mfa-email-challenge.tsx#L33) + +Hook to access transaction state and authentication flow data. + +**Returns** + +[`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 + +**Example** + +```jsx +import { useTransaction } from '@auth0/auth0-acul-react/login-id'; +function TransactionInfo() { + const transaction = useTransaction(); +} +``` + + +() => UntrustedDataMembers}> +> **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/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. + +**Returns** + +[`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 + +**Example** + +```jsx +import { useUntrustedData } from '@auth0/auth0-acul-react/login-id'; +function PrefilledForm() { + const untrustedData = useUntrustedData(); +} +``` + + +() => UserMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/reset-password-mfa-email-challenge.tsx#L26) + +Hook to access user information and profile data. + +**Returns** + +[`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 + +**Example** + +```jsx +import { useUser } from '@auth0/auth0-acul-react/login-id'; +function UserProfile() { + const user = useUser(); +} +``` + + + +## Functions + +void | Promise<void>}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/reset-password-mfa-email-challenge.tsx#L38) + +**Parameters** + +**payload** + +[`ContinueOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ContinueOptions) + +**Returns** + +`void` \| `Promise`\<`void`\> + + +void | Promise<void>}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/reset-password-mfa-email-challenge.tsx#L39) + +**Parameters** + +**payload?** + +[`ResendCodeOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResendCodeOptions) + +**Returns** + +`void` \| `Promise`\<`void`\> + + +void | Promise<void>}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/reset-password-mfa-email-challenge.tsx#L40) + +**Parameters** + +**payload?** + +[`TryAnotherMethodOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TryAnotherMethodOptions) + +**Returns** + +`void` \| `Promise`\<`void`\> + + +ResetPasswordMfaEmailChallengeMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/reset-password-mfa-email-challenge.tsx#L58) + +**Returns** + +[`ResetPasswordMfaEmailChallengeMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResetPasswordMfaEmailChallengeMembers) + + + +## References + +useResend} type='Hooks'/> + +useCurrentScreen} type='Hooks'/> + +useErrors} type='Hooks'/> + +useAuth0Themes} type='Hooks'/> + +UseErrorOptions} type='Types'/> + +UseErrorsResult} type='Types'/> + +ErrorsResult} type='Types'/> + +ErrorKind} 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..cd7ba97aa --- /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 + +() => BrandingMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/reset-password-mfa-otp-challenge.tsx#L25) + +Hook to access branding and theme configuration. + +**Returns** + +[`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 + +**Example** + +```jsx +import { useBranding } from '@auth0/auth0-acul-react/login-id'; +function CustomTheme() { + const branding = useBranding(); +} +``` + + +() => ClientMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/reset-password-mfa-otp-challenge.tsx#L26) + +Hook to access Auth0 application (client) configuration. + +**Returns** + +[`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 + +**Example** + +```jsx +import { useClient } from '@auth0/auth0-acul-react/login-id'; +function AppInfo() { + const client = useClient(); +} +``` + + +() => OrganizationMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/reset-password-mfa-otp-challenge.tsx#L27) + +Hook to access organization context and settings. + +**Returns** + +[`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/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

No organization context

; + } +} +``` + + +() => PromptMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/reset-password-mfa-otp-challenge.tsx#L28) + +Hook to access prompt configuration and flow settings. + +**Returns** + +[`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 + +**Example** + +```jsx +import { usePrompt } from '@auth0/auth0-acul-react/login-id'; +function FlowInfo() { + const prompt = usePrompt(); +} +``` + + +() => ScreenMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/reset-password-mfa-otp-challenge.tsx#L29) + +Hook to access current screen information and metadata. + +**Returns** + +[`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 + +**Example** + +```jsx +import { useScreen } from '@auth0/auth0-acul-react/login-id'; +function ScreenDebug() { + const screen = useScreen(); +} +``` + + +() => TenantMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/reset-password-mfa-otp-challenge.tsx#L24) + +Hook to access tenant configuration and settings. + +**Returns** + +[`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/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(); +} +``` + + +() => TransactionMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/reset-password-mfa-otp-challenge.tsx#L30) + +Hook to access transaction state and authentication flow data. + +**Returns** + +[`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 + +**Example** + +```jsx +import { useTransaction } from '@auth0/auth0-acul-react/login-id'; +function TransactionInfo() { + const transaction = useTransaction(); +} +``` + + +() => UntrustedDataMembers}> +> **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/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. + +**Returns** + +[`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 + +**Example** + +```jsx +import { useUntrustedData } from '@auth0/auth0-acul-react/login-id'; +function PrefilledForm() { + const untrustedData = useUntrustedData(); +} +``` + + +() => UserMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/reset-password-mfa-otp-challenge.tsx#L23) + +Hook to access user information and profile data. + +**Returns** + +[`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 + +**Example** + +```jsx +import { useUser } from '@auth0/auth0-acul-react/login-id'; +function UserProfile() { + const user = useUser(); +} +``` + + + +## Functions + +void | Promise<void>}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/reset-password-mfa-otp-challenge.tsx#L35) + +**Parameters** + +**payload** + +[`ResetPasswordMfaOtpChallengeContinueOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResetPasswordMfaOtpChallengeContinueOptions) + +**Returns** + +`void` \| `Promise`\<`void`\> + + +void | Promise<void>}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/reset-password-mfa-otp-challenge.tsx#L36) + +**Parameters** + +**payload?** + +[`ResetPasswordMfaOtpChallengeTryAnotherMethodOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResetPasswordMfaOtpChallengeTryAnotherMethodOptions) + +**Returns** + +`void` \| `Promise`\<`void`\> + + +ResetPasswordMfaOtpChallengeMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/reset-password-mfa-otp-challenge.tsx#L51) + +**Returns** + +[`ResetPasswordMfaOtpChallengeMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResetPasswordMfaOtpChallengeMembers) + + + +## References + +useCurrentScreen} type='Hooks'/> + +useErrors} type='Hooks'/> + +useAuth0Themes} type='Hooks'/> + +UseErrorOptions} type='Types'/> + +UseErrorsResult} type='Types'/> + +ErrorsResult} type='Types'/> + +ErrorKind} 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..ec5f8aa1b --- /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 + +() => BrandingMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/reset-password-mfa-phone-challenge.tsx#L27) + +Hook to access branding and theme configuration. + +**Returns** + +[`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 + +**Example** + +```jsx +import { useBranding } from '@auth0/auth0-acul-react/login-id'; +function CustomTheme() { + const branding = useBranding(); +} +``` + + +() => ClientMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/reset-password-mfa-phone-challenge.tsx#L28) + +Hook to access Auth0 application (client) configuration. + +**Returns** + +[`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 + +**Example** + +```jsx +import { useClient } from '@auth0/auth0-acul-react/login-id'; +function AppInfo() { + const client = useClient(); +} +``` + + +() => OrganizationMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/reset-password-mfa-phone-challenge.tsx#L29) + +Hook to access organization context and settings. + +**Returns** + +[`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/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

No organization context

; + } +} +``` + + +() => PromptMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/reset-password-mfa-phone-challenge.tsx#L30) + +Hook to access prompt configuration and flow settings. + +**Returns** + +[`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 + +**Example** + +```jsx +import { usePrompt } from '@auth0/auth0-acul-react/login-id'; +function FlowInfo() { + const prompt = usePrompt(); +} +``` + + +() => ScreenMembersOnResetPasswordMfaPhoneChallenge}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/reset-password-mfa-phone-challenge.tsx#L31) + +Hook to access current screen information and metadata. + +**Returns** + +[`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 + +**Example** + +```jsx +import { useScreen } from '@auth0/auth0-acul-react/login-id'; +function ScreenDebug() { + const screen = useScreen(); +} +``` + + +() => TenantMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/reset-password-mfa-phone-challenge.tsx#L26) + +Hook to access tenant configuration and settings. + +**Returns** + +[`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/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(); +} +``` + + +() => TransactionMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/reset-password-mfa-phone-challenge.tsx#L32) + +Hook to access transaction state and authentication flow data. + +**Returns** + +[`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 + +**Example** + +```jsx +import { useTransaction } from '@auth0/auth0-acul-react/login-id'; +function TransactionInfo() { + const transaction = useTransaction(); +} +``` + + +() => UntrustedDataMembers}> +> **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/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. + +**Returns** + +[`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 + +**Example** + +```jsx +import { useUntrustedData } from '@auth0/auth0-acul-react/login-id'; +function PrefilledForm() { + const untrustedData = useUntrustedData(); +} +``` + + +() => UserMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/reset-password-mfa-phone-challenge.tsx#L25) + +Hook to access user information and profile data. + +**Returns** + +[`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 + +**Example** + +```jsx +import { useUser } from '@auth0/auth0-acul-react/login-id'; +function UserProfile() { + const user = useUser(); +} +``` + + + +## Functions + +void | Promise<void>}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/reset-password-mfa-phone-challenge.tsx#L37) + +**Parameters** + +**payload** + +[`ResetPasswordMfaPhoneChallengeContinueOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResetPasswordMfaPhoneChallengeContinueOptions) + +**Returns** + +`void` \| `Promise`\<`void`\> + + +void | Promise<void>}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/reset-password-mfa-phone-challenge.tsx#L38) + +**Parameters** + +**payload** + +[`ResetPasswordMfaPhoneChallengeTryAnotherMethodOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResetPasswordMfaPhoneChallengeTryAnotherMethodOptions) + +**Returns** + +`void` \| `Promise`\<`void`\> + + +ResetPasswordMfaPhoneChallengeMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/reset-password-mfa-phone-challenge.tsx#L53) + +**Returns** + +[`ResetPasswordMfaPhoneChallengeMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResetPasswordMfaPhoneChallengeMembers) + + + +## References + +useCurrentScreen} type='Hooks'/> + +useErrors} type='Hooks'/> + +useAuth0Themes} type='Hooks'/> + +UseErrorOptions} type='Types'/> + +UseErrorsResult} type='Types'/> + +ErrorsResult} type='Types'/> + +ErrorKind} 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..276aef3cc --- /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 + +() => BrandingMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/reset-password-mfa-push-challenge-push.tsx#L26) + +Hook to access branding and theme configuration. + +**Returns** + +[`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 + +**Example** + +```jsx +import { useBranding } from '@auth0/auth0-acul-react/login-id'; +function CustomTheme() { + const branding = useBranding(); +} +``` + + +() => ClientMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/reset-password-mfa-push-challenge-push.tsx#L27) + +Hook to access Auth0 application (client) configuration. + +**Returns** + +[`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 + +**Example** + +```jsx +import { useClient } from '@auth0/auth0-acul-react/login-id'; +function AppInfo() { + const client = useClient(); +} +``` + + +() => OrganizationMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/reset-password-mfa-push-challenge-push.tsx#L28) + +Hook to access organization context and settings. + +**Returns** + +[`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/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

No organization context

; + } +} +``` + + +() => PromptMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/reset-password-mfa-push-challenge-push.tsx#L29) + +Hook to access prompt configuration and flow settings. + +**Returns** + +[`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 + +**Example** + +```jsx +import { usePrompt } from '@auth0/auth0-acul-react/login-id'; +function FlowInfo() { + const prompt = usePrompt(); +} +``` + + +() => ScreenMembersOnResetPasswordMfaPushChallengePush}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/reset-password-mfa-push-challenge-push.tsx#L30) + +Hook to access current screen information and metadata. + +**Returns** + +[`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 + +**Example** + +```jsx +import { useScreen } from '@auth0/auth0-acul-react/login-id'; +function ScreenDebug() { + const screen = useScreen(); +} +``` + + +() => TenantMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/reset-password-mfa-push-challenge-push.tsx#L25) + +Hook to access tenant configuration and settings. + +**Returns** + +[`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/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(); +} +``` + + +() => TransactionMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/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`](/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 + +**Example** + +```jsx +import { useTransaction } from '@auth0/auth0-acul-react/login-id'; +function TransactionInfo() { + const transaction = useTransaction(); +} +``` + + +() => UntrustedDataMembers}> +> **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/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. + +**Returns** + +[`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 + +**Example** + +```jsx +import { useUntrustedData } from '@auth0/auth0-acul-react/login-id'; +function PrefilledForm() { + const untrustedData = useUntrustedData(); +} +``` + + +() => UserMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/reset-password-mfa-push-challenge-push.tsx#L24) + +Hook to access user information and profile data. + +**Returns** + +[`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 + +**Example** + +```jsx +import { useUser } from '@auth0/auth0-acul-react/login-id'; +function UserProfile() { + const user = useUser(); +} +``` + + + +## Functions + +void | Promise<void>}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/reset-password-mfa-push-challenge-push.tsx#L36) + +**Parameters** + +**payload?** + +[`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CustomOptions) + +**Returns** + +`void` \| `Promise`\<`void`\> + + +void | Promise<void>}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/reset-password-mfa-push-challenge-push.tsx#L39) + +**Parameters** + +**payload?** + +[`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CustomOptions) + +**Returns** + +`void` \| `Promise`\<`void`\> + + +void | Promise<void>}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/reset-password-mfa-push-challenge-push.tsx#L37) + +**Parameters** + +**payload?** + +[`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CustomOptions) + +**Returns** + +`void` \| `Promise`\<`void`\> + + +void | Promise<void>}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/reset-password-mfa-push-challenge-push.tsx#L41) + +**Parameters** + +**payload?** + +[`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CustomOptions) + +**Returns** + +`void` \| `Promise`\<`void`\> + + +ResetPasswordMfaPushChallengePushMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/reset-password-mfa-push-challenge-push.tsx#L59) + +**Returns** + +[`ResetPasswordMfaPushChallengePushMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResetPasswordMfaPushChallengePushMembers) + + + +## References + +useMfaPolling} type='Hooks'/> + +useCurrentScreen} type='Hooks'/> + +useErrors} type='Hooks'/> + +useAuth0Themes} type='Hooks'/> + +UseErrorOptions} type='Types'/> + +UseErrorsResult} type='Types'/> + +ErrorsResult} type='Types'/> + +ErrorKind} 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..8979bf92c --- /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 + +() => BrandingMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/reset-password-mfa-recovery-code-challenge.tsx#L26) + +Hook to access branding and theme configuration. + +**Returns** + +[`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 + +**Example** + +```jsx +import { useBranding } from '@auth0/auth0-acul-react/login-id'; +function CustomTheme() { + const branding = useBranding(); +} +``` + + +() => ClientMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/reset-password-mfa-recovery-code-challenge.tsx#L27) + +Hook to access Auth0 application (client) configuration. + +**Returns** + +[`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 + +**Example** + +```jsx +import { useClient } from '@auth0/auth0-acul-react/login-id'; +function AppInfo() { + const client = useClient(); +} +``` + + +() => OrganizationMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/reset-password-mfa-recovery-code-challenge.tsx#L28) + +Hook to access organization context and settings. + +**Returns** + +[`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/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

No organization context

; + } +} +``` + + +() => PromptMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/reset-password-mfa-recovery-code-challenge.tsx#L29) + +Hook to access prompt configuration and flow settings. + +**Returns** + +[`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 + +**Example** + +```jsx +import { usePrompt } from '@auth0/auth0-acul-react/login-id'; +function FlowInfo() { + const prompt = usePrompt(); +} +``` + + +() => ScreenMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/reset-password-mfa-recovery-code-challenge.tsx#L30) + +Hook to access current screen information and metadata. + +**Returns** + +[`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 + +**Example** + +```jsx +import { useScreen } from '@auth0/auth0-acul-react/login-id'; +function ScreenDebug() { + const screen = useScreen(); +} +``` + + +() => TenantMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/reset-password-mfa-recovery-code-challenge.tsx#L25) + +Hook to access tenant configuration and settings. + +**Returns** + +[`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/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(); +} +``` + + +() => TransactionMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/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`](/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 + +**Example** + +```jsx +import { useTransaction } from '@auth0/auth0-acul-react/login-id'; +function TransactionInfo() { + const transaction = useTransaction(); +} +``` + + +() => UntrustedDataMembers}> +> **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/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. + +**Returns** + +[`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 + +**Example** + +```jsx +import { useUntrustedData } from '@auth0/auth0-acul-react/login-id'; +function PrefilledForm() { + const untrustedData = useUntrustedData(); +} +``` + + +() => UserMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/reset-password-mfa-recovery-code-challenge.tsx#L24) + +Hook to access user information and profile data. + +**Returns** + +[`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 + +**Example** + +```jsx +import { useUser } from '@auth0/auth0-acul-react/login-id'; +function UserProfile() { + const user = useUser(); +} +``` + + + +## Functions + +void | Promise<void>}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/reset-password-mfa-recovery-code-challenge.tsx#L36) + +**Parameters** + +**code** + +`string` + +**payload?** + +[`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CustomOptions) + +**Returns** + +`void` \| `Promise`\<`void`\> + + +void | Promise<void>}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/reset-password-mfa-recovery-code-challenge.tsx#L38) + +**Parameters** + +**payload?** + +[`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CustomOptions) + +**Returns** + +`void` \| `Promise`\<`void`\> + + +ResetPasswordMfaRecoveryCodeChallengeMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/reset-password-mfa-recovery-code-challenge.tsx#L54) + +**Returns** + +[`ResetPasswordMfaRecoveryCodeChallengeMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResetPasswordMfaRecoveryCodeChallengeMembers) + + + +## References + +useCurrentScreen} type='Hooks'/> + +useErrors} type='Hooks'/> + +useAuth0Themes} type='Hooks'/> + +UseErrorOptions} type='Types'/> + +UseErrorsResult} type='Types'/> + +ErrorsResult} type='Types'/> + +ErrorKind} 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..7a89eb623 --- /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 + +() => BrandingMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/reset-password-mfa-sms-challenge.tsx#L25) + +Hook to access branding and theme configuration. + +**Returns** + +[`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 + +**Example** + +```jsx +import { useBranding } from '@auth0/auth0-acul-react/login-id'; +function CustomTheme() { + const branding = useBranding(); +} +``` + + +() => ClientMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/reset-password-mfa-sms-challenge.tsx#L26) + +Hook to access Auth0 application (client) configuration. + +**Returns** + +[`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 + +**Example** + +```jsx +import { useClient } from '@auth0/auth0-acul-react/login-id'; +function AppInfo() { + const client = useClient(); +} +``` + + +() => OrganizationMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/reset-password-mfa-sms-challenge.tsx#L27) + +Hook to access organization context and settings. + +**Returns** + +[`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/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

No organization context

; + } +} +``` + + +() => PromptMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/reset-password-mfa-sms-challenge.tsx#L28) + +Hook to access prompt configuration and flow settings. + +**Returns** + +[`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 + +**Example** + +```jsx +import { usePrompt } from '@auth0/auth0-acul-react/login-id'; +function FlowInfo() { + const prompt = usePrompt(); +} +``` + + +() => ScreenMembersOnResetPasswordMfaSmsChallenge}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/reset-password-mfa-sms-challenge.tsx#L29) + +Hook to access current screen information and metadata. + +**Returns** + +[`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 + +**Example** + +```jsx +import { useScreen } from '@auth0/auth0-acul-react/login-id'; +function ScreenDebug() { + const screen = useScreen(); +} +``` + + +() => TenantMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/reset-password-mfa-sms-challenge.tsx#L24) + +Hook to access tenant configuration and settings. + +**Returns** + +[`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/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(); +} +``` + + +() => TransactionMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/reset-password-mfa-sms-challenge.tsx#L30) + +Hook to access transaction state and authentication flow data. + +**Returns** + +[`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 + +**Example** + +```jsx +import { useTransaction } from '@auth0/auth0-acul-react/login-id'; +function TransactionInfo() { + const transaction = useTransaction(); +} +``` + + +() => UntrustedDataMembers}> +> **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/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. + +**Returns** + +[`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 + +**Example** + +```jsx +import { useUntrustedData } from '@auth0/auth0-acul-react/login-id'; +function PrefilledForm() { + const untrustedData = useUntrustedData(); +} +``` + + +() => UserMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/reset-password-mfa-sms-challenge.tsx#L23) + +Hook to access user information and profile data. + +**Returns** + +[`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 + +**Example** + +```jsx +import { useUser } from '@auth0/auth0-acul-react/login-id'; +function UserProfile() { + const user = useUser(); +} +``` + + + +## Functions + +void | Promise<void>}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/reset-password-mfa-sms-challenge.tsx#L35) + +**Parameters** + +**payload** + +[`ResetPasswordMfaSmsChallengeOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResetPasswordMfaSmsChallengeOptions) + +**Returns** + +`void` \| `Promise`\<`void`\> + + +void | Promise<void>}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/reset-password-mfa-sms-challenge.tsx#L40) + +**Parameters** + +**payload?** + +[`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CustomOptions) + +**Returns** + +`void` \| `Promise`\<`void`\> + + +void | Promise<void>}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/reset-password-mfa-sms-challenge.tsx#L37) + +**Parameters** + +**payload?** + +[`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CustomOptions) + +**Returns** + +`void` \| `Promise`\<`void`\> + + +void | Promise<void>}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/reset-password-mfa-sms-challenge.tsx#L38) + +**Parameters** + +**payload?** + +[`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CustomOptions) + +**Returns** + +`void` \| `Promise`\<`void`\> + + +ResetPasswordMfaSmsChallengeMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/reset-password-mfa-sms-challenge.tsx#L57) + +**Returns** + +[`ResetPasswordMfaSmsChallengeMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResetPasswordMfaSmsChallengeMembers) + + + +## References + +useResend} type='Hooks'/> + +useCurrentScreen} type='Hooks'/> + +useErrors} type='Hooks'/> + +useAuth0Themes} type='Hooks'/> + +UseErrorOptions} type='Types'/> + +UseErrorsResult} type='Types'/> + +ErrorsResult} type='Types'/> + +ErrorKind} 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..8ba10cccd --- /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 + +() => BrandingMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/reset-password-mfa-voice-challenge.tsx#L27) + +Hook to access branding and theme configuration. + +**Returns** + +[`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 + +**Example** + +```jsx +import { useBranding } from '@auth0/auth0-acul-react/login-id'; +function CustomTheme() { + const branding = useBranding(); +} +``` + + +() => ClientMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/reset-password-mfa-voice-challenge.tsx#L28) + +Hook to access Auth0 application (client) configuration. + +**Returns** + +[`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 + +**Example** + +```jsx +import { useClient } from '@auth0/auth0-acul-react/login-id'; +function AppInfo() { + const client = useClient(); +} +``` + + +() => OrganizationMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/reset-password-mfa-voice-challenge.tsx#L29) + +Hook to access organization context and settings. + +**Returns** + +[`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/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

No organization context

; + } +} +``` + + +() => PromptMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/reset-password-mfa-voice-challenge.tsx#L30) + +Hook to access prompt configuration and flow settings. + +**Returns** + +[`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 + +**Example** + +```jsx +import { usePrompt } from '@auth0/auth0-acul-react/login-id'; +function FlowInfo() { + const prompt = usePrompt(); +} +``` + + +() => ScreenMembersOnResetPasswordMfaVoiceChallenge}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/reset-password-mfa-voice-challenge.tsx#L31) + +Hook to access current screen information and metadata. + +**Returns** + +[`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 + +**Example** + +```jsx +import { useScreen } from '@auth0/auth0-acul-react/login-id'; +function ScreenDebug() { + const screen = useScreen(); +} +``` + + +() => TenantMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/reset-password-mfa-voice-challenge.tsx#L26) + +Hook to access tenant configuration and settings. + +**Returns** + +[`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/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(); +} +``` + + +() => TransactionMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/reset-password-mfa-voice-challenge.tsx#L32) + +Hook to access transaction state and authentication flow data. + +**Returns** + +[`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 + +**Example** + +```jsx +import { useTransaction } from '@auth0/auth0-acul-react/login-id'; +function TransactionInfo() { + const transaction = useTransaction(); +} +``` + + +() => UntrustedDataMembers}> +> **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/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. + +**Returns** + +[`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 + +**Example** + +```jsx +import { useUntrustedData } from '@auth0/auth0-acul-react/login-id'; +function PrefilledForm() { + const untrustedData = useUntrustedData(); +} +``` + + +() => UserMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/reset-password-mfa-voice-challenge.tsx#L25) + +Hook to access user information and profile data. + +**Returns** + +[`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 + +**Example** + +```jsx +import { useUser } from '@auth0/auth0-acul-react/login-id'; +function UserProfile() { + const user = useUser(); +} +``` + + + +## Functions + +void | Promise<void>}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/reset-password-mfa-voice-challenge.tsx#L37) + +**Parameters** + +**payload** + +[`ResetPasswordMfaVoiceChallengeContinueOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResetPasswordMfaVoiceChallengeContinueOptions) + +**Returns** + +`void` \| `Promise`\<`void`\> + + +void | Promise<void>}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/reset-password-mfa-voice-challenge.tsx#L39) + +**Parameters** + +**payload?** + +[`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CustomOptions) + +**Returns** + +`void` \| `Promise`\<`void`\> + + +void | Promise<void>}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/reset-password-mfa-voice-challenge.tsx#L38) + +**Parameters** + +**payload?** + +[`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CustomOptions) + +**Returns** + +`void` \| `Promise`\<`void`\> + + +void | Promise<void>}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/reset-password-mfa-voice-challenge.tsx#L40) + +**Parameters** + +**payload?** + +[`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CustomOptions) + +**Returns** + +`void` \| `Promise`\<`void`\> + + +ResetPasswordMfaVoiceChallengeMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/reset-password-mfa-voice-challenge.tsx#L58) + +**Returns** + +[`ResetPasswordMfaVoiceChallengeMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResetPasswordMfaVoiceChallengeMembers) + + + +## References + +useResend} type='Hooks'/> + +useCurrentScreen} type='Hooks'/> + +useErrors} type='Hooks'/> + +useAuth0Themes} type='Hooks'/> + +UseErrorOptions} type='Types'/> + +UseErrorsResult} type='Types'/> + +ErrorsResult} type='Types'/> + +ErrorKind} 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..942c360c1 --- /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 + +() => BrandingMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/reset-password-mfa-webauthn-platform-challenge.tsx#L28) + +Hook to access branding and theme configuration. + +**Returns** + +[`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 + +**Example** + +```jsx +import { useBranding } from '@auth0/auth0-acul-react/login-id'; +function CustomTheme() { + const branding = useBranding(); +} +``` + + +() => ClientMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/reset-password-mfa-webauthn-platform-challenge.tsx#L29) + +Hook to access Auth0 application (client) configuration. + +**Returns** + +[`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 + +**Example** + +```jsx +import { useClient } from '@auth0/auth0-acul-react/login-id'; +function AppInfo() { + const client = useClient(); +} +``` + + +() => OrganizationMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/reset-password-mfa-webauthn-platform-challenge.tsx#L30) + +Hook to access organization context and settings. + +**Returns** + +[`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/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

No organization context

; + } +} +``` + + +() => PromptMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/reset-password-mfa-webauthn-platform-challenge.tsx#L31) + +Hook to access prompt configuration and flow settings. + +**Returns** + +[`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 + +**Example** + +```jsx +import { usePrompt } from '@auth0/auth0-acul-react/login-id'; +function FlowInfo() { + const prompt = usePrompt(); +} +``` + + +() => ScreenMembersOnResetPasswordMfaWebAuthnPlatformChallenge}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/reset-password-mfa-webauthn-platform-challenge.tsx#L32) + +Hook to access current screen information and metadata. + +**Returns** + +[`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 + +**Example** + +```jsx +import { useScreen } from '@auth0/auth0-acul-react/login-id'; +function ScreenDebug() { + const screen = useScreen(); +} +``` + + +() => TenantMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/reset-password-mfa-webauthn-platform-challenge.tsx#L27) + +Hook to access tenant configuration and settings. + +**Returns** + +[`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/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(); +} +``` + + +() => TransactionMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/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`](/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 + +**Example** + +```jsx +import { useTransaction } from '@auth0/auth0-acul-react/login-id'; +function TransactionInfo() { + const transaction = useTransaction(); +} +``` + + +() => UntrustedDataMembers}> +> **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/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. + +**Returns** + +[`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 + +**Example** + +```jsx +import { useUntrustedData } from '@auth0/auth0-acul-react/login-id'; +function PrefilledForm() { + const untrustedData = useUntrustedData(); +} +``` + + +() => UserMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/reset-password-mfa-webauthn-platform-challenge.tsx#L26) + +Hook to access user information and profile data. + +**Returns** + +[`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 + +**Example** + +```jsx +import { useUser } from '@auth0/auth0-acul-react/login-id'; +function UserProfile() { + const user = useUser(); +} +``` + + + +## Functions + +void | Promise<void>}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/reset-password-mfa-webauthn-platform-challenge.tsx#L38) + +**Parameters** + +**options?** + +[`ResetPasswordMfaWebAuthnPlatformChallengeContinueOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResetPasswordMfaWebAuthnPlatformChallengeContinueOptions) + +**Returns** + +`void` \| `Promise`\<`void`\> + + +void | Promise<void>}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/reset-password-mfa-webauthn-platform-challenge.tsx#L40) + +**Parameters** + +**options** + +[`ResetPasswordMfaWebAuthnPlatformChallengeReportErrorOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResetPasswordMfaWebAuthnPlatformChallengeReportErrorOptions) + +**Returns** + +`void` \| `Promise`\<`void`\> + + +void | Promise<void>}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/reset-password-mfa-webauthn-platform-challenge.tsx#L42) + +**Parameters** + +**options?** + +[`ResetPasswordMfaWebAuthnPlatformChallengeTryAnotherMethodOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResetPasswordMfaWebAuthnPlatformChallengeTryAnotherMethodOptions) + +**Returns** + +`void` \| `Promise`\<`void`\> + + +ResetPasswordMfaWebAuthnPlatformChallengeMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/reset-password-mfa-webauthn-platform-challenge.tsx#L58) + +**Returns** + +[`ResetPasswordMfaWebAuthnPlatformChallengeMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResetPasswordMfaWebAuthnPlatformChallengeMembers) + + + +## References + +useCurrentScreen} type='Hooks'/> + +useErrors} type='Hooks'/> + +useAuth0Themes} type='Hooks'/> + +UseErrorOptions} type='Types'/> + +UseErrorsResult} type='Types'/> + +ErrorsResult} type='Types'/> + +ErrorKind} 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..7cac4f91d --- /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 + +() => BrandingMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/reset-password-mfa-webauthn-roaming-challenge.tsx#L28) + +Hook to access branding and theme configuration. + +**Returns** + +[`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 + +**Example** + +```jsx +import { useBranding } from '@auth0/auth0-acul-react/login-id'; +function CustomTheme() { + const branding = useBranding(); +} +``` + + +() => ClientMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/reset-password-mfa-webauthn-roaming-challenge.tsx#L29) + +Hook to access Auth0 application (client) configuration. + +**Returns** + +[`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 + +**Example** + +```jsx +import { useClient } from '@auth0/auth0-acul-react/login-id'; +function AppInfo() { + const client = useClient(); +} +``` + + +() => OrganizationMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/reset-password-mfa-webauthn-roaming-challenge.tsx#L30) + +Hook to access organization context and settings. + +**Returns** + +[`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/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

No organization context

; + } +} +``` + + +() => PromptMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/reset-password-mfa-webauthn-roaming-challenge.tsx#L31) + +Hook to access prompt configuration and flow settings. + +**Returns** + +[`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 + +**Example** + +```jsx +import { usePrompt } from '@auth0/auth0-acul-react/login-id'; +function FlowInfo() { + const prompt = usePrompt(); +} +``` + + +() => ScreenMembersOnResetPasswordMfaWebAuthnRoamingChallenge}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/reset-password-mfa-webauthn-roaming-challenge.tsx#L32) + +Hook to access current screen information and metadata. + +**Returns** + +[`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 + +**Example** + +```jsx +import { useScreen } from '@auth0/auth0-acul-react/login-id'; +function ScreenDebug() { + const screen = useScreen(); +} +``` + + +() => TenantMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/reset-password-mfa-webauthn-roaming-challenge.tsx#L27) + +Hook to access tenant configuration and settings. + +**Returns** + +[`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/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(); +} +``` + + +() => TransactionMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/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`](/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 + +**Example** + +```jsx +import { useTransaction } from '@auth0/auth0-acul-react/login-id'; +function TransactionInfo() { + const transaction = useTransaction(); +} +``` + + +() => UntrustedDataMembers}> +> **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/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. + +**Returns** + +[`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 + +**Example** + +```jsx +import { useUntrustedData } from '@auth0/auth0-acul-react/login-id'; +function PrefilledForm() { + const untrustedData = useUntrustedData(); +} +``` + + +() => UserMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/reset-password-mfa-webauthn-roaming-challenge.tsx#L26) + +Hook to access user information and profile data. + +**Returns** + +[`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 + +**Example** + +```jsx +import { useUser } from '@auth0/auth0-acul-react/login-id'; +function UserProfile() { + const user = useUser(); +} +``` + + + +## Functions + +void | Promise<void>}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/reset-password-mfa-webauthn-roaming-challenge.tsx#L40) + +**Parameters** + +**options** + +[`ResetPasswordMfaWebAuthnRoamingChallengeShowErrorOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResetPasswordMfaWebAuthnRoamingChallengeShowErrorOptions) + +**Returns** + +`void` \| `Promise`\<`void`\> + + +void | Promise<void>}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/reset-password-mfa-webauthn-roaming-challenge.tsx#L41) + +**Parameters** + +**options?** + +[`ResetPasswordMfaWebAuthnRoamingChallengeTryAnotherMethodOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResetPasswordMfaWebAuthnRoamingChallengeTryAnotherMethodOptions) + +**Returns** + +`void` \| `Promise`\<`void`\> + + +ResetPasswordMfaWebAuthnRoamingChallengeMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/reset-password-mfa-webauthn-roaming-challenge.tsx#L57) + +**Returns** + +[`ResetPasswordMfaWebAuthnRoamingChallengeMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResetPasswordMfaWebAuthnRoamingChallengeMembers) + + +void | Promise<void>}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/reset-password-mfa-webauthn-roaming-challenge.tsx#L38) + +**Parameters** + +**options?** + +[`ResetPasswordMfaWebAuthnRoamingChallengeUseSecurityKeyOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResetPasswordMfaWebAuthnRoamingChallengeUseSecurityKeyOptions) + +**Returns** + +`void` \| `Promise`\<`void`\> + + + +## References + +useCurrentScreen} type='Hooks'/> + +useErrors} type='Hooks'/> + +useAuth0Themes} type='Hooks'/> + +UseErrorOptions} type='Types'/> + +UseErrorsResult} type='Types'/> + +ErrorsResult} type='Types'/> + +ErrorKind} 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..c208b53df --- /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 + +() => BrandingMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/reset-password-request.tsx#L25) + +Hook to access branding and theme configuration. + +**Returns** + +[`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 + +**Example** + +```jsx +import { useBranding } from '@auth0/auth0-acul-react/login-id'; +function CustomTheme() { + const branding = useBranding(); +} +``` + + +() => ClientMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/reset-password-request.tsx#L26) + +Hook to access Auth0 application (client) configuration. + +**Returns** + +[`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 + +**Example** + +```jsx +import { useClient } from '@auth0/auth0-acul-react/login-id'; +function AppInfo() { + const client = useClient(); +} +``` + + +() => OrganizationMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/reset-password-request.tsx#L27) + +Hook to access organization context and settings. + +**Returns** + +[`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/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

No organization context

; + } +} +``` + + +() => PromptMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/reset-password-request.tsx#L28) + +Hook to access prompt configuration and flow settings. + +**Returns** + +[`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 + +**Example** + +```jsx +import { usePrompt } from '@auth0/auth0-acul-react/login-id'; +function FlowInfo() { + const prompt = usePrompt(); +} +``` + + +() => ScreenMembersOnResetPasswordRequest}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/reset-password-request.tsx#L29) + +Hook to access current screen information and metadata. + +**Returns** + +[`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 + +**Example** + +```jsx +import { useScreen } from '@auth0/auth0-acul-react/login-id'; +function ScreenDebug() { + const screen = useScreen(); +} +``` + + +() => TenantMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/reset-password-request.tsx#L24) + +Hook to access tenant configuration and settings. + +**Returns** + +[`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/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(); +} +``` + + +() => TransactionMembersOnResetPasswordRequest}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/reset-password-request.tsx#L30) + +Hook to access transaction state and authentication flow data. + +**Returns** + +[`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 + +**Example** + +```jsx +import { useTransaction } from '@auth0/auth0-acul-react/login-id'; +function TransactionInfo() { + const transaction = useTransaction(); +} +``` + + +() => UntrustedDataMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/reset-password-request.tsx#L31) + +Hook to access untrusted data from URL parameters and form submissions. + +**Returns** + +[`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 + +**Example** + +```jsx +import { useUntrustedData } from '@auth0/auth0-acul-react/login-id'; +function PrefilledForm() { + const untrustedData = useUntrustedData(); +} +``` + + +() => UserMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/reset-password-request.tsx#L23) + +Hook to access user information and profile data. + +**Returns** + +[`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 + +**Example** + +```jsx +import { useUser } from '@auth0/auth0-acul-react/login-id'; +function UserProfile() { + const user = useUser(); +} +``` + + + +## Functions + +void | Promise<void>}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/reset-password-request.tsx#L37) + +**Parameters** + +**payload?** + +[`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CustomOptions) + +**Returns** + +`void` \| `Promise`\<`void`\> + + +void | Promise<void>}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/reset-password-request.tsx#L35) + +**Parameters** + +**payload** + +[`ResetPasswordRequestOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResetPasswordRequestOptions) + +**Returns** + +`void` \| `Promise`\<`void`\> + + +ResetPasswordRequestMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/reset-password-request.tsx#L54) + +**Returns** + +[`ResetPasswordRequestMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResetPasswordRequestMembers) + + + +## References + +useLoginIdentifiers} type='Hooks'/> + +useCurrentScreen} type='Hooks'/> + +useErrors} type='Hooks'/> + +useAuth0Themes} type='Hooks'/> + +UseErrorOptions} type='Types'/> + +UseErrorsResult} type='Types'/> + +ErrorsResult} type='Types'/> + +ErrorKind} 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..6fc8ca09c --- /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 + +() => BrandingMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/reset-password-success.tsx#L17) + +Hook to access branding and theme configuration. + +**Returns** + +[`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 + +**Example** + +```jsx +import { useBranding } from '@auth0/auth0-acul-react/login-id'; +function CustomTheme() { + const branding = useBranding(); +} +``` + + +() => ClientMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/reset-password-success.tsx#L18) + +Hook to access Auth0 application (client) configuration. + +**Returns** + +[`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 + +**Example** + +```jsx +import { useClient } from '@auth0/auth0-acul-react/login-id'; +function AppInfo() { + const client = useClient(); +} +``` + + +() => OrganizationMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/reset-password-success.tsx#L19) + +Hook to access organization context and settings. + +**Returns** + +[`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/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

No organization context

; + } +} +``` + + +() => PromptMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/reset-password-success.tsx#L20) + +Hook to access prompt configuration and flow settings. + +**Returns** + +[`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 + +**Example** + +```jsx +import { usePrompt } from '@auth0/auth0-acul-react/login-id'; +function FlowInfo() { + const prompt = usePrompt(); +} +``` + + +() => ScreenMembersOnResetPasswordSuccess}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/reset-password-success.tsx#L21) + +Hook to access current screen information and metadata. + +**Returns** + +[`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 + +**Example** + +```jsx +import { useScreen } from '@auth0/auth0-acul-react/login-id'; +function ScreenDebug() { + const screen = useScreen(); +} +``` + + +() => TenantMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/reset-password-success.tsx#L16) + +Hook to access tenant configuration and settings. + +**Returns** + +[`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/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(); +} +``` + + +() => TransactionMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/reset-password-success.tsx#L22) + +Hook to access transaction state and authentication flow data. + +**Returns** + +[`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 + +**Example** + +```jsx +import { useTransaction } from '@auth0/auth0-acul-react/login-id'; +function TransactionInfo() { + const transaction = useTransaction(); +} +``` + + +() => UntrustedDataMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/reset-password-success.tsx#L23) + +Hook to access untrusted data from URL parameters and form submissions. + +**Returns** + +[`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 + +**Example** + +```jsx +import { useUntrustedData } from '@auth0/auth0-acul-react/login-id'; +function PrefilledForm() { + const untrustedData = useUntrustedData(); +} +``` + + +() => UserMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/reset-password-success.tsx#L15) + +Hook to access user information and profile data. + +**Returns** + +[`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 + +**Example** + +```jsx +import { useUser } from '@auth0/auth0-acul-react/login-id'; +function UserProfile() { + const user = useUser(); +} +``` + + + +## Functions + +ResetPasswordSuccessMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/reset-password-success.tsx#L38) + +**Returns** + +[`ResetPasswordSuccessMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResetPasswordSuccessMembers) + + + +## References + +useCurrentScreen} type='Hooks'/> + +useErrors} type='Hooks'/> + +useAuth0Themes} type='Hooks'/> + +UseErrorOptions} type='Types'/> + +UseErrorsResult} type='Types'/> + +ErrorsResult} type='Types'/> + +ErrorKind} 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..6d0e86c6c --- /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 + +() => BrandingMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/reset-password.tsx#L24) + +Hook to access branding and theme configuration. + +**Returns** + +[`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 + +**Example** + +```jsx +import { useBranding } from '@auth0/auth0-acul-react/login-id'; +function CustomTheme() { + const branding = useBranding(); +} +``` + + +() => ClientMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/reset-password.tsx#L25) + +Hook to access Auth0 application (client) configuration. + +**Returns** + +[`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 + +**Example** + +```jsx +import { useClient } from '@auth0/auth0-acul-react/login-id'; +function AppInfo() { + const client = useClient(); +} +``` + + +() => OrganizationMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/reset-password.tsx#L26) + +Hook to access organization context and settings. + +**Returns** + +[`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/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

No organization context

; + } +} +``` + + +() => PromptMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/reset-password.tsx#L27) + +Hook to access prompt configuration and flow settings. + +**Returns** + +[`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 + +**Example** + +```jsx +import { usePrompt } from '@auth0/auth0-acul-react/login-id'; +function FlowInfo() { + const prompt = usePrompt(); +} +``` + + +() => ScreenMembersOnResetPassword}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/reset-password.tsx#L28) + +Hook to access current screen information and metadata. + +**Returns** + +[`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 + +**Example** + +```jsx +import { useScreen } from '@auth0/auth0-acul-react/login-id'; +function ScreenDebug() { + const screen = useScreen(); +} +``` + + +() => TenantMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/reset-password.tsx#L23) + +Hook to access tenant configuration and settings. + +**Returns** + +[`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/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(); +} +``` + + +() => TransactionMembersOnResetPassword}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/reset-password.tsx#L29) + +Hook to access transaction state and authentication flow data. + +**Returns** + +[`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 + +**Example** + +```jsx +import { useTransaction } from '@auth0/auth0-acul-react/login-id'; +function TransactionInfo() { + const transaction = useTransaction(); +} +``` + + +() => UntrustedDataMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/reset-password.tsx#L30) + +Hook to access untrusted data from URL parameters and form submissions. + +**Returns** + +[`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 + +**Example** + +```jsx +import { useUntrustedData } from '@auth0/auth0-acul-react/login-id'; +function PrefilledForm() { + const untrustedData = useUntrustedData(); +} +``` + + +() => UserMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/reset-password.tsx#L22) + +Hook to access user information and profile data. + +**Returns** + +[`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 + +**Example** + +```jsx +import { useUser } from '@auth0/auth0-acul-react/login-id'; +function UserProfile() { + const user = useUser(); +} +``` + + + +## Functions + +void | Promise<void>}> +> **resetPassword**(`payload`): `void` \| `Promise`\<`void`\> + +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** + +**payload** + +[`ResetPasswordOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResetPasswordOptions) + +**Returns** + +`void` \| `Promise`\<`void`\> + + +ResetPasswordMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/reset-password.tsx#L52) + +**Returns** + +[`ResetPasswordMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResetPasswordMembers) + + + +## References + +usePasswordValidation} type='Hooks'/> + +useCurrentScreen} type='Hooks'/> + +useErrors} type='Hooks'/> + +useAuth0Themes} type='Hooks'/> + +UseErrorOptions} type='Types'/> + +UseErrorsResult} type='Types'/> + +ErrorsResult} type='Types'/> + +ErrorKind} 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..b8f44cc94 --- /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 + +() => BrandingMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/signup-id.tsx#L26) + +Hook to access branding and theme configuration. + +**Returns** + +[`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 + +**Example** + +```jsx +import { useBranding } from '@auth0/auth0-acul-react/login-id'; +function CustomTheme() { + const branding = useBranding(); +} +``` + + +() => ClientMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/signup-id.tsx#L27) + +Hook to access Auth0 application (client) configuration. + +**Returns** + +[`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 + +**Example** + +```jsx +import { useClient } from '@auth0/auth0-acul-react/login-id'; +function AppInfo() { + const client = useClient(); +} +``` + + +() => OrganizationMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/signup-id.tsx#L28) + +Hook to access organization context and settings. + +**Returns** + +[`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/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

No organization context

; + } +} +``` + + +() => PromptMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/signup-id.tsx#L29) + +Hook to access prompt configuration and flow settings. + +**Returns** + +[`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 + +**Example** + +```jsx +import { usePrompt } from '@auth0/auth0-acul-react/login-id'; +function FlowInfo() { + const prompt = usePrompt(); +} +``` + + +() => ScreenMembersOnSignupId}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/signup-id.tsx#L30) + +Hook to access current screen information and metadata. + +**Returns** + +[`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 + +**Example** + +```jsx +import { useScreen } from '@auth0/auth0-acul-react/login-id'; +function ScreenDebug() { + const screen = useScreen(); +} +``` + + +() => TenantMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/signup-id.tsx#L25) + +Hook to access tenant configuration and settings. + +**Returns** + +[`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/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(); +} +``` + + +() => TransactionMembersOnSignupId}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/signup-id.tsx#L31) + +Hook to access transaction state and authentication flow data. + +**Returns** + +[`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 + +**Example** + +```jsx +import { useTransaction } from '@auth0/auth0-acul-react/login-id'; +function TransactionInfo() { + const transaction = useTransaction(); +} +``` + + +() => UntrustedDataMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/signup-id.tsx#L32) + +Hook to access untrusted data from URL parameters and form submissions. + +**Returns** + +[`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 + +**Example** + +```jsx +import { useUntrustedData } from '@auth0/auth0-acul-react/login-id'; +function PrefilledForm() { + const untrustedData = useUntrustedData(); +} +``` + + +() => UserMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/signup-id.tsx#L24) + +Hook to access user information and profile data. + +**Returns** + +[`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 + +**Example** + +```jsx +import { useUser } from '@auth0/auth0-acul-react/login-id'; +function UserProfile() { + const user = useUser(); +} +``` + + + +## Functions + +void | Promise<void>}> +> **federatedSignup**(`payload`): `void` \| `Promise`\<`void`\> + +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** + +**payload** + +[`FederatedSignupOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/FederatedSignupOptions) + +**Returns** + +`void` \| `Promise`\<`void`\> + + +void | Promise<void>}> +> **pickCountryCode**(`payload?`): `void` \| `Promise`\<`void`\> + +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** + +**payload?** + +[`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CustomOptions) + +**Returns** + +`void` \| `Promise`\<`void`\> + + +void | Promise<void>}> +> **signup**(`payload`): `void` \| `Promise`\<`void`\> + +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** + +**payload** + +[`SignupOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/SignupOptions) + +**Returns** + +`void` \| `Promise`\<`void`\> + + +SignupIdMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/signup-id.tsx#L60) + +**Returns** + +[`SignupIdMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/SignupIdMembers) + + + +## References + +useSignupIdentifiers} type='Hooks'/> + +useUsernameValidation} type='Hooks'/> + +useCurrentScreen} type='Hooks'/> + +useErrors} type='Hooks'/> + +useAuth0Themes} type='Hooks'/> + +UseErrorOptions} type='Types'/> + +UseErrorsResult} type='Types'/> + +ErrorsResult} type='Types'/> + +ErrorKind} 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..9ef5cbf5a --- /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 + +() => BrandingMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/signup-password.tsx#L25) + +Hook to access branding and theme configuration. + +**Returns** + +[`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 + +**Example** + +```jsx +import { useBranding } from '@auth0/auth0-acul-react/login-id'; +function CustomTheme() { + const branding = useBranding(); +} +``` + + +() => ClientMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/signup-password.tsx#L26) + +Hook to access Auth0 application (client) configuration. + +**Returns** + +[`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 + +**Example** + +```jsx +import { useClient } from '@auth0/auth0-acul-react/login-id'; +function AppInfo() { + const client = useClient(); +} +``` + + +() => OrganizationMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/signup-password.tsx#L27) + +Hook to access organization context and settings. + +**Returns** + +[`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/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

No organization context

; + } +} +``` + + +() => PromptMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/signup-password.tsx#L28) + +Hook to access prompt configuration and flow settings. + +**Returns** + +[`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 + +**Example** + +```jsx +import { usePrompt } from '@auth0/auth0-acul-react/login-id'; +function FlowInfo() { + const prompt = usePrompt(); +} +``` + + +() => ScreenMembersOnSignupPassword}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/signup-password.tsx#L29) + +Hook to access current screen information and metadata. + +**Returns** + +[`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 + +**Example** + +```jsx +import { useScreen } from '@auth0/auth0-acul-react/login-id'; +function ScreenDebug() { + const screen = useScreen(); +} +``` + + +() => TenantMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/signup-password.tsx#L24) + +Hook to access tenant configuration and settings. + +**Returns** + +[`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/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(); +} +``` + + +() => TransactionMembersOnSignupPassword}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/signup-password.tsx#L30) + +Hook to access transaction state and authentication flow data. + +**Returns** + +[`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 + +**Example** + +```jsx +import { useTransaction } from '@auth0/auth0-acul-react/login-id'; +function TransactionInfo() { + const transaction = useTransaction(); +} +``` + + +() => UntrustedDataMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/signup-password.tsx#L31) + +Hook to access untrusted data from URL parameters and form submissions. + +**Returns** + +[`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 + +**Example** + +```jsx +import { useUntrustedData } from '@auth0/auth0-acul-react/login-id'; +function PrefilledForm() { + const untrustedData = useUntrustedData(); +} +``` + + +() => UserMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/signup-password.tsx#L23) + +Hook to access user information and profile data. + +**Returns** + +[`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 + +**Example** + +```jsx +import { useUser } from '@auth0/auth0-acul-react/login-id'; +function UserProfile() { + const user = useUser(); +} +``` + + + +## Functions + +void | Promise<void>}> +> **federatedSignup**(`payload`): `void` \| `Promise`\<`void`\> + +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** + +**payload** + +[`FederatedSignupPasswordPayloadOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/FederatedSignupPasswordPayloadOptions) + +**Returns** + +`void` \| `Promise`\<`void`\> + + +void | Promise<void>}> +> **signup**(`payload`): `void` \| `Promise`\<`void`\> + +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** + +**payload** + +[`SignupPasswordOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/SignupPasswordOptions) + +**Returns** + +`void` \| `Promise`\<`void`\> + + +SignupPasswordMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/signup-password.tsx#L54) + +**Returns** + +[`SignupPasswordMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/SignupPasswordMembers) + + + +## References + +usePasswordValidation} type='Hooks'/> + +useCurrentScreen} type='Hooks'/> + +useErrors} type='Hooks'/> + +useAuth0Themes} type='Hooks'/> + +UseErrorOptions} type='Types'/> + +UseErrorsResult} type='Types'/> + +ErrorsResult} type='Types'/> + +ErrorKind} 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..907c38323 --- /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 + +() => BrandingMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/signup.tsx#L26) + +Hook to access branding and theme configuration. + +**Returns** + +[`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 + +**Example** + +```jsx +import { useBranding } from '@auth0/auth0-acul-react/login-id'; +function CustomTheme() { + const branding = useBranding(); +} +``` + + +() => ClientMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/signup.tsx#L27) + +Hook to access Auth0 application (client) configuration. + +**Returns** + +[`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 + +**Example** + +```jsx +import { useClient } from '@auth0/auth0-acul-react/login-id'; +function AppInfo() { + const client = useClient(); +} +``` + + +() => OrganizationMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/signup.tsx#L28) + +Hook to access organization context and settings. + +**Returns** + +[`OrganizationMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/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

No organization context

; + } +} +``` + + +() => PromptMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/signup.tsx#L29) + +Hook to access prompt configuration and flow settings. + +**Returns** + +[`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 + +**Example** + +```jsx +import { usePrompt } from '@auth0/auth0-acul-react/login-id'; +function FlowInfo() { + const prompt = usePrompt(); +} +``` + + +() => ScreenMembersOnSignup}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/signup.tsx#L30) + +Hook to access current screen information and metadata. + +**Returns** + +[`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 + +**Example** + +```jsx +import { useScreen } from '@auth0/auth0-acul-react/login-id'; +function ScreenDebug() { + const screen = useScreen(); +} +``` + + +() => TenantMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/signup.tsx#L25) + +Hook to access tenant configuration and settings. + +**Returns** + +[`TenantMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/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(); +} +``` + + +() => TransactionMembersOnSignup}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/signup.tsx#L31) + +Hook to access transaction state and authentication flow data. + +**Returns** + +[`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 + +**Example** + +```jsx +import { useTransaction } from '@auth0/auth0-acul-react/login-id'; +function TransactionInfo() { + const transaction = useTransaction(); +} +``` + + +() => UntrustedDataMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/signup.tsx#L32) + +Hook to access untrusted data from URL parameters and form submissions. + +**Returns** + +[`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 + +**Example** + +```jsx +import { useUntrustedData } from '@auth0/auth0-acul-react/login-id'; +function PrefilledForm() { + const untrustedData = useUntrustedData(); +} +``` + + +() => UserMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/signup.tsx#L24) + +Hook to access user information and profile data. + +**Returns** + +[`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 + +**Example** + +```jsx +import { useUser } from '@auth0/auth0-acul-react/login-id'; +function UserProfile() { + const user = useUser(); +} +``` + + + +## Functions + +void | Promise<void>}> +> **federatedSignup**(`payload`): `void` \| `Promise`\<`void`\> + +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** + +**payload** + +[`FederatedSignupPayloadOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/FederatedSignupPayloadOptions) + +**Returns** + +`void` \| `Promise`\<`void`\> + + +void | Promise<void>}> +> **pickCountryCode**(`payload?`): `void` \| `Promise`\<`void`\> + +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** + +**payload?** + +[`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CustomOptions) + +**Returns** + +`void` \| `Promise`\<`void`\> + + +void | Promise<void>}> +> **signup**(`payload`): `void` \| `Promise`\<`void`\> + +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** + +**payload** + +[`SignupPayloadOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/SignupPayloadOptions) + +**Returns** + +`void` \| `Promise`\<`void`\> + + +SignupMembers}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/screens/signup.tsx#L63) + +**Returns** + +[`SignupMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/SignupMembers) + + + +## References + +usePasswordValidation} type='Hooks'/> + +useSignupIdentifiers} type='Hooks'/> + +useUsernameValidation} type='Hooks'/> + +useCurrentScreen} type='Hooks'/> + +useErrors} type='Hooks'/> + +useAuth0Themes} type='Hooks'/> + +UseErrorOptions} type='Types'/> + +UseErrorsResult} type='Types'/> + +ErrorsResult} type='Types'/> + +ErrorKind} 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..51e4cb0a8 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/classes/ContextHooks.mdx @@ -0,0 +1,239 @@ +--- +title: "ContextHooks" +--- + +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. + +## Type Parameters + +### T + +`T` *extends* [`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/hooks/context/index.tsx#L8) + +#### Parameters + + + + +- Returns `ContextHooks`\<`T`\> + +## Methods + + +> **useUser**(): `T`\[`"user"`\] + +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. + +**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(); +} +``` + + + +> **useTenant**(): `T`\[`"tenant"`\] + +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. + +**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(); +} +``` + + + +> **useBranding**(): `T`\[`"branding"`\] + +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. + +**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(); +} +``` + + + +> **useClient**(): `T`\[`"client"`\] + +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. + +**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(); +} +``` + + + +> **useOrganization**(): `T`\[`"organization"`\] + +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. + +**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

No organization context

; + } +} +``` + + + +> **usePrompt**(): `T`\[`"prompt"`\] + +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. + +**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(); +} +``` + + + +> **useUntrustedData**(): `T`\[`"untrustedData"`\] + +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. + +**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(); +} +``` + + + +> **useScreen**(): `T`\[`"screen"`\] + +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. + +**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(); +} +``` + + + +> **useTransaction**(): `T`\[`"transaction"`\] + +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. + +**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(); +} +``` + 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..9b7a2ae62 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/index.mdx @@ -0,0 +1,322 @@ +--- +title: "Types" +--- + +## Classes + +- [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](/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](/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 + +Error} type='Interfaces'/> + +useAuth0Themes} type='Hooks'/> + +useCurrentScreen} type='Hooks'/> + +useErrors} type='Hooks'/> + +useLoginIdentifiers} type='Hooks'/> + +useSignupIdentifiers} type='Hooks'/> + +useMfaPolling} type='Hooks'/> + +useResend} type='Hooks'/> + +usePasswordValidation} type='Hooks'/> + +useUsernameValidation} type='Hooks'/> 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 + + +> `optional` **doNotShowAgain**: `boolean` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/passkey-enrollment-local.d.ts:16 + 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..bf74c1511 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/AcceptInvitationMembers.mdx @@ -0,0 +1,129 @@ +--- +title: "AcceptInvitationMembers" +--- + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/accept-invitation.d.ts:14 + +- Extends [`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers) + +## Properties + +BrandingMembers}> +> **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`](/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#branding) + + + +TenantMembers}> +> **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`](/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#tenant) + + + +UserMembers}> +> **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`](/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#user) + + + +UntrustedDataMembers}> +> **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`](/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#untrusteddata) + + + +ClientMembers}> +> **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`](/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#client) + + + +OrganizationMembers}> +> **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`](/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#organization) + + + +PromptMembers}> +> **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`](/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#prompt) + + + +ScreenMembersOnAcceptInvitation}> +> **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`](/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#screen) + + + +TransactionMembers}> +> **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`](/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#transaction) + +**Methods** + + + +> **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`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CustomOptions) + +Optional custom options to include with the request. + +**Returns** + +`Promise`\<`void`\> + 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..51309c8f8 --- /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 + + +> **type**: `"public-key"` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:9 + + + + +> **id**: `string` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:10 + + + +AuthenticatorTransport[]}> +> `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/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 + + +> **type**: `string` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:57 + 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..819ef3781 --- /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`](/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 + +BrandingMembers}> +> **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 + + + +ClientMembers}> +> **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 + + + +OrganizationMembers}> +> **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 + + + +PromptMembers}> +> **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 + + + +ScreenMembers}> +> **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 + + + +TenantMembers}> +> **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 + + + +TransactionMembers}> +> **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 + + + +UserMembers}> +> **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 + + + +UntrustedDataMembers}> +> **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 + 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..1ed03768f --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/Branding.mdx @@ -0,0 +1,19 @@ +--- +title: "Branding" +--- + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/organization.d.ts:17 + +## Properties + + +> `optional` **logoUrl**: `string` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/organization.d.ts:18 + + + + + + + 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..4f4c77ef8 --- /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 + +BrandingSettings}> +> **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 + + + +BrandingThemes}> +> **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 new file mode 100644 index 000000000..78a1286c4 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingSettings.mdx @@ -0,0 +1,32 @@ +--- +title: "BrandingSettings" +--- + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/branding.d.ts:29 + +## Properties + + + + + + + +> `optional` **faviconUrl**: `string` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/branding.d.ts:39 + + + + +> `optional` **logoUrl**: `string` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/branding.d.ts:40 + + + + +> `optional` **fontUrl**: `string` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/branding.d.ts:41 + 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..ffe3dfb81 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BrandingThemes.mdx @@ -0,0 +1,31 @@ +--- +title: "BrandingThemes" +--- + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/branding.d.ts:43 + +## Properties + + + + + + + + + + + + + + + + + + + + + + + + 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 + + +> **provider**: `string` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:2 + + + + +> `optional` **image**: `string` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:3 + + + + +> `optional` **siteKey**: `string` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:4 + 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..6d3c66370 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ClientMembers.mdx @@ -0,0 +1,44 @@ +--- +title: "ClientMembers" +--- + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/client.d.ts:10 + +## Properties + + +> **id**: `string` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/client.d.ts:11 + + + + +> **name**: `string` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/client.d.ts:12 + + + + +> **logoUrl**: `string` \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/client.d.ts:13 + + + + +> **description**: `string` \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/client.d.ts:14 + + + + + + + + + + + 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..c6032d97b --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ConfirmLogoutOptions.mdx @@ -0,0 +1,23 @@ +--- +title: "ConfirmLogoutOptions" +--- + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/logout.d.ts:6 + +Options for confirming logout + +- Extends [`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CustomOptions) + +## Indexable + +\[`key`: `string`\]: `string` \| `number` \| `boolean` \| `undefined` + +## Properties + + +> **action**: `"accept"` \| `"deny"` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/logout.d.ts:8 + +The authentication transaction state + 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..57b56cbd7 --- /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`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/EnterpriseConnection) + +## Properties + + +> **name**: `string` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/transaction.d.ts:2 + + + + +> **strategy**: `string` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/transaction.d.ts:3 + + + + +> `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/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..94119a3ef --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ConsentMembers.mdx @@ -0,0 +1,207 @@ +--- +title: "ConsentMembers" +--- + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/consent.d.ts:38 + +ConsentMembers + +- Extends [`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers) + +## Properties + +BrandingMembers}> +> **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`](/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#branding) + + + +ClientMembers}> +> **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`](/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#client) + + + +OrganizationMembers}> +> **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`](/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#organization) + + + +PromptMembers}> +> **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`](/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#prompt) + + + +TenantMembers}> +> **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`](/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#tenant) + + + +TransactionMembers}> +> **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`](/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#transaction) + + + +UserMembers}> +> **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`](/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#user) + + + +UntrustedDataMembers}> +> **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`](/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#untrusteddata) + + + +ScreenMembersOnConsent}> +> **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 + +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/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`screen`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers#screen) + +**Methods** + + + +> **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`](/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 + 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. +``` + + + + +> **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`](/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 + 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. +``` + 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 + + +> **code**: `string` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/mfa-otp-challenge.d.ts:25 + +The code entered by the user + + + + +> `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 + 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 + + +> **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. + + + + +> `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. + 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 + + +> **code**: `string` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/mfa-email-challenge.d.ts:28 + +The code entered by the user + + + + +> `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 + 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..e333b17ac --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ContinueWithCodeOptionPayload.mdx @@ -0,0 +1,37 @@ +--- +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`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CustomOptions) + +## Indexable + +\[`key`: `string`\]: `string` \| `number` \| `boolean` \| `undefined` + +## Properties + + +> **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" +``` + 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 + + +> **organizationName**: `string` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/organization-selection.d.ts:15 + +The organization name. + 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..14dfe00c6 --- /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 + + +> **clientDataJSON**: `string` \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/utils/passkeys.d.ts:15 + + + + +> **attestationObject**: `string` \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/utils/passkeys.d.ts:16 + + + + +> `optional` **transports**: `string`[] + +Defined in: packages/auth0-acul-js/dist/types/interfaces/utils/passkeys.d.ts:17 + 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..61f32e643 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CurrentScreenOptions.mdx @@ -0,0 +1,84 @@ +--- +title: "CurrentScreenOptions" +--- + +Defined in: packages/auth0-acul-js/dist/types/interfaces/common/index.d.ts:25 + +CurrentScreenOptions details. + +## Properties + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Error[]}> + + + + + + + + + + + + + + + + + + + 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..4f0d1eabe --- /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`](/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 + +\[`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..441a2933c --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CustomizedConsentMembers.mdx @@ -0,0 +1,209 @@ +--- +title: "CustomizedConsentMembers" +--- + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/customized-consent.d.ts:49 + +CustomizedConsentMembers + +- Extends [`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers) + +## Properties + +BrandingMembers}> +> **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`](/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#branding) + + + +ClientMembers}> +> **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`](/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#client) + + + +OrganizationMembers}> +> **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`](/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#organization) + + + +PromptMembers}> +> **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`](/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#prompt) + + + +TenantMembers}> +> **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`](/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#tenant) + + + +TransactionMembers}> +> **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`](/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#transaction) + + + +UserMembers}> +> **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`](/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#user) + + + +UntrustedDataMembers}> +> **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`](/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#untrusteddata) + + + +ScreenMembersOnCustomizedConsent}> +> **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 + +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/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`screen`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers#screen) + +**Methods** + + + +> **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`](/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 + 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. +``` + + + + +> **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`](/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 + 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. +``` + 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..85d2a3dbd --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/DeviceCodeActivationAllowedMembers.mdx @@ -0,0 +1,109 @@ +--- +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`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers) + +## Properties + +BrandingMembers}> +> **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`](/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#branding) + + + +ClientMembers}> +> **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`](/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#client) + + + +OrganizationMembers}> +> **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`](/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#organization) + + + +PromptMembers}> +> **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`](/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#prompt) + + + +ScreenMembers}> +> **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`](/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#screen) + + + +TenantMembers}> +> **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`](/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#tenant) + + + +TransactionMembers}> +> **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`](/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#transaction) + + + +UserMembers}> +> **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`](/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#user) + + + +UntrustedDataMembers}> +> **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`](/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#untrusteddata) + 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..62ce6954b --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/DeviceCodeActivationContinueOptions.mdx @@ -0,0 +1,25 @@ +--- +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`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CustomOptions) + +## Indexable + +\[`key`: `string`\]: `string` \| `number` \| `boolean` \| `undefined` + +## Properties + + +> **code**: `string` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/device-code-activation.d.ts:11 + 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..6d26bacc6 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/DeviceCodeActivationDeniedMembers.mdx @@ -0,0 +1,109 @@ +--- +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`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers) + +## Properties + +BrandingMembers}> +> **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`](/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#branding) + + + +ClientMembers}> +> **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`](/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#client) + + + +OrganizationMembers}> +> **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`](/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#organization) + + + +PromptMembers}> +> **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`](/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#prompt) + + + +ScreenMembers}> +> **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`](/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#screen) + + + +TenantMembers}> +> **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`](/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#tenant) + + + +TransactionMembers}> +> **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`](/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#transaction) + + + +UserMembers}> +> **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`](/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#user) + + + +UntrustedDataMembers}> +> **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`](/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#untrusteddata) + 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..178755c4d --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/DeviceCodeActivationMembers.mdx @@ -0,0 +1,135 @@ +--- +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`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers) + +## Properties + +BrandingMembers}> +> **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`](/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#branding) + + + +ClientMembers}> +> **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`](/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#client) + + + +OrganizationMembers}> +> **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`](/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#organization) + + + +PromptMembers}> +> **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`](/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#prompt) + + + +ScreenMembers}> +> **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`](/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#screen) + + + +TenantMembers}> +> **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`](/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#tenant) + + + +TransactionMembers}> +> **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`](/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#transaction) + + + +UserMembers}> +> **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`](/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#user) + + + +UntrustedDataMembers}> +> **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`](/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#untrusteddata) + +**Methods** + + + +> **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`](/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. + +**Returns** + +`Promise`\<`void`\> + +A promise that resolves when the code is successfully submitted. +Rejects with an error if the submission fails. + 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..fefe4c8ec --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/DeviceCodeConfirmationMembers.mdx @@ -0,0 +1,152 @@ +--- +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`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers) + +## Properties + +BrandingMembers}> +> **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`](/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#branding) + + + +ClientMembers}> +> **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`](/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#client) + + + +OrganizationMembers}> +> **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`](/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#organization) + + + +PromptMembers}> +> **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`](/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#prompt) + + + +TenantMembers}> +> **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`](/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#tenant) + + + +TransactionMembers}> +> **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`](/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#transaction) + + + +UserMembers}> +> **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`](/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#user) + + + +UntrustedDataMembers}> +> **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`](/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#untrusteddata) + + + +ScreenMembersOnDeviceCodeConfirmation}> +> **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`](/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#screen) + +**Methods** + + + +> **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`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CustomOptions) + +Optional custom options to include with the request. + +**Returns** + +`Promise`\<`void`\> + + + + +> **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`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CustomOptions) + +Optional custom options to include with the request. + +**Returns** + +`Promise`\<`void`\> + 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 + + +> **code**: `string` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/email-identifier-challenge.d.ts:6 + + + + +> `optional` **captcha**: `string` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/email-identifier-challenge.d.ts:7 + 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..575942ca3 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/EmailIdentifierChallengeMembers.mdx @@ -0,0 +1,176 @@ +--- +title: "EmailIdentifierChallengeMembers" +--- + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/email-identifier-challenge.d.ts:17 + +- Extends [`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers) + +## Properties + +BrandingMembers}> +> **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`](/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#branding) + + + +ClientMembers}> +> **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`](/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#client) + + + +OrganizationMembers}> +> **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`](/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#organization) + + + +PromptMembers}> +> **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`](/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#prompt) + + + +TenantMembers}> +> **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`](/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#tenant) + + + +TransactionMembers}> +> **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`](/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#transaction) + + + +UserMembers}> +> **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`](/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#user) + + + +UntrustedDataMembers}> +> **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`](/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#untrusteddata) + + + +ScreenMembersOnEmailIdentifierChallenge}> +> **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`](/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#screen) + +**Methods** + + + +> **submitEmailChallenge**(`payload`): `Promise`\<`void`\> + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/email-identifier-challenge.d.ts:19 + +**Parameters** + +**payload** + +[`EmailChallengeOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/EmailChallengeOptions) + +**Returns** + +`Promise`\<`void`\> + + + + +> **resendCode**(`payload?`): `Promise`\<`void`\> + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/email-identifier-challenge.d.ts:20 + +**Parameters** + +**payload?** + +[`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CustomOptions) + +**Returns** + +`Promise`\<`void`\> + + + + +> **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 + +**Parameters** + +**payload?** + +[`StartResendOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/StartResendOptions) + +**Returns** + +[`ResendControl`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResendControl) + + + + +> **returnToPrevious**(`payload?`): `Promise`\<`void`\> + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/email-identifier-challenge.d.ts:22 + +**Parameters** + +**payload?** + +[`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CustomOptions) + +**Returns** + +`Promise`\<`void`\> + 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..3aa7488e1 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/EmailOTPChallengeMembers.mdx @@ -0,0 +1,173 @@ +--- +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`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers) + +## Properties + +BrandingMembers}> +> **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`](/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#branding) + + + +ClientMembers}> +> **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`](/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#client) + + + +OrganizationMembers}> +> **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`](/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#organization) + + + +PromptMembers}> +> **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`](/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#prompt) + + + +TenantMembers}> +> **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`](/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#tenant) + + + +TransactionMembers}> +> **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`](/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#transaction) + + + +UserMembers}> +> **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`](/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#user) + + + +UntrustedDataMembers}> +> **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`](/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#untrusteddata) + + + +ScreenMembersOnEmailOTPChallenge}> +> **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`](/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#screen) + +**Methods** + + + +> **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`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OtpCodeOptions) + +Optional parameters to include in the submission. + +**Returns** + +`Promise`\<`void`\> + + + + +> **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`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CustomOptions) + +Optional parameters to include in the resend request. + +**Returns** + +`Promise`\<`void`\> + + + + +> **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 + +Gets resend functionality with timeout management for this screen + +**Parameters** + +**options?** + +[`StartResendOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/StartResendOptions) + +Configuration options for resend functionality + +**Returns** + +[`ResendControl`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResendControl) + 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..fac8acef9 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/EmailVerificationResultMembers.mdx @@ -0,0 +1,111 @@ +--- +title: "EmailVerificationResultMembers" +--- + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/email-verification-result.d.ts:42 + +EmailVerificationResultMembers + +- Extends [`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers) + +## Properties + +BrandingMembers}> +> **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`](/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#branding) + + + +ClientMembers}> +> **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`](/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#client) + + + +OrganizationMembers}> +> **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`](/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#organization) + + + +PromptMembers}> +> **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`](/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#prompt) + + + +TenantMembers}> +> **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`](/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#tenant) + + + +TransactionMembers}> +> **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`](/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#transaction) + + + +UserMembers}> +> **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`](/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#user) + + + +UntrustedDataMembers}> +> **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`](/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#untrusteddata) + + + +ScreenMembersOnEmailVerificationResult}> +> **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 + +Screen-specific data, including verification status and login link. + +**Overrides** + +[`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#screen) + 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 + + +> **id**: `number` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/user.d.ts:11 + + + + +> **device**: `string` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/user.d.ts:12 + 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 + + +> **id**: `number` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/user.d.ts:3 + + + + +> **email**: `string` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/user.d.ts:4 + 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 + + +> **id**: `number` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/user.d.ts:7 + + + + +> **phoneNumber**: `string` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/user.d.ts:8 + 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..634b60a18 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/EnterpriseConnection.mdx @@ -0,0 +1,51 @@ +--- +title: "EnterpriseConnection" +--- + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/transaction.d.ts:116 + +- Extends [`Connection`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/Connection) + +## Properties + + +> **name**: `string` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/transaction.d.ts:2 + +**Inherited from** + +[`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#name) + + + + +> **strategy**: `string` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/transaction.d.ts:3 + +**Inherited from** + +[`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#strategy) + + + + +> `optional` **metadata**: `Record`\<`string`, `string`\> + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/transaction.d.ts:4 + +**Inherited from** + +[`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#metadata) + + + + + + + + + + + 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..be716a209 --- /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`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ErrorItem) + +## Properties + + +> **code**: `string` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/transaction.d.ts:138 + + + + +> `optional` **field**: `string` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/transaction.d.ts:139 + + + + +> **message**: `string` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/transaction.d.ts:140 + + + +PasswordComplexityRule[]}> +> `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 new file mode 100644 index 000000000..0ed766465 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ErrorItem.mdx @@ -0,0 +1,73 @@ +--- +title: "ErrorItem" +--- + +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 [`Error`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/Error) + +## Properties + + +> **code**: `string` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/transaction.d.ts:138 + +**Inherited from** + +[`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#code) + + + + +> `optional` **field**: `string` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/transaction.d.ts:139 + +**Inherited from** + +[`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#field) + + + + +> **message**: `string` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/transaction.d.ts:140 + +**Inherited from** + +[`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#message) + + + +PasswordComplexityRule[]}> +> `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`](/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#rules) + + + + +> **id**: `string` + +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) + + + + +> `optional` **label**: `string` + +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) + + + +ErrorKind}> +> `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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/state/error-store.ts#L6) + 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..28c92948b --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ErrorsResult.mdx @@ -0,0 +1,55 @@ +--- +title: "ErrorsResult" +--- + +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 `ReadonlyArray`\<[`ErrorItem`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ErrorItem)\> + +## Indexable + +\[`n`: `number`\]: [`ErrorItem`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ErrorItem) + +## Methods + +### byKind() + +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/hooks/common/errors.ts#L13) + +#### Parameters + +##### kind + +[`ErrorKind`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/type-aliases/ErrorKind) + +##### opts? + +###### field? + +`string` + +- Returns readonly [`ErrorItem`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ErrorItem)[] + +*** + +### byField() + +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/hooks/common/errors.ts#L14) + +#### Parameters + +##### field + +`string` + +##### opts? + +###### kind? + +[`ErrorKind`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/type-aliases/ErrorKind) + +- Returns 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/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 + + +> **connection**: `string` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/login-id.d.ts:45 + 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 + + +> **connection**: `string` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/login-password.d.ts:42 + 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 + + +> **connection**: `string` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/login.d.ts:66 + +The social connection name to use + 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 + + +> **connection**: `string` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/signup-id.d.ts:36 + 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 + + +> **connection**: `string` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/signup-password.d.ts:21 + 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 + + +> **connection**: `string` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/signup.d.ts:18 + 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..9c69deeb4 --- /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 + + +> **colors**: `Record`\<`string`, `string`\> + +Defined in: packages/auth0-acul-js/dist/types/interfaces/common/index.d.ts:53 + + + + +> **fonts**: `Record`\<`string`, `string` \| `number` \| `boolean` \| `object`\> + +Defined in: packages/auth0-acul-js/dist/types/interfaces/common/index.d.ts:54 + + + + +> **borders**: `Record`\<`string`, `string` \| `number` \| `boolean`\> + +Defined in: packages/auth0-acul-js/dist/types/interfaces/common/index.d.ts:55 + + + + +> **pageBackground**: `Record`\<`string`, `string`\> + +Defined in: packages/auth0-acul-js/dist/types/interfaces/common/index.d.ts:56 + + + + +> **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/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..c935e574f --- /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 + +ScreenIdentifierType}> +> **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 + +The type of identifier, such as `'email'`, `'phone'`, or `'username'`. + +**See** + +IdentifierType + + + + +> **required**: `boolean` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/utils/signup-identifiers.d.ts:39 + +Whether this identifier is required for signup. + 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..8ce2c34e3 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/InterstitialCaptchaMembers.mdx @@ -0,0 +1,124 @@ +--- +title: "InterstitialCaptchaMembers" +--- + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/interstitial-captcha.d.ts:6 + +- Extends [`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers) + +## Properties + +BrandingMembers}> +> **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`](/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#branding) + + + +ClientMembers}> +> **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`](/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#client) + + + +OrganizationMembers}> +> **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`](/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#organization) + + + +PromptMembers}> +> **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`](/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#prompt) + + + +ScreenMembers}> +> **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`](/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#screen) + + + +TenantMembers}> +> **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`](/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#tenant) + + + +TransactionMembers}> +> **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`](/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#transaction) + + + +UserMembers}> +> **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`](/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#user) + + + +UntrustedDataMembers}> +> **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`](/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#untrusteddata) + + + + +> **submitCaptcha**: (`payload`) => `void` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/interstitial-captcha.d.ts:7 + +**Parameters** + +**payload** + +[`SubmitCaptchaOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/SubmitCaptchaOptions) + +**Returns** + +`void` + 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..00cac6e4e --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/LoginEmailVerificationMembers.mdx @@ -0,0 +1,266 @@ +--- +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`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers) + +## Properties + +BrandingMembers}> +> **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`](/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#branding) + + + +ClientMembers}> +> **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`](/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#client) + + + +OrganizationMembers}> +> **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`](/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#organization) + + + +PromptMembers}> +> **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`](/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#prompt) + + + +ScreenMembers}> +> **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`](/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#screen) + + + +TenantMembers}> +> **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`](/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#tenant) + + + +TransactionMembers}> +> **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`](/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#transaction) + + + +UserMembers}> +> **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`](/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#user) + + + +UntrustedDataMembers}> +> **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`](/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#untrusteddata) + +**Methods** + + + +> **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`](/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. + +**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. + } + }); +} +``` + + + + +> **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`](/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. + +**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." + } + }); +} +``` + + + + +> **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 + +Gets resend functionality with timeout management for this screen + +**Parameters** + +**options?** + +[`StartResendOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/StartResendOptions) + +Configuration options for resend functionality + +**Returns** + +[`ResendControl`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResendControl) + 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..3bdd30d15 --- /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 + +MfaLoginFactorType}> +> **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 + +The action indicating which factor to use for login + 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..850517eb8 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/LoginIdMembers.mdx @@ -0,0 +1,187 @@ +--- +title: "LoginIdMembers" +--- + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/login-id.d.ts:48 + +- Extends [`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers) + +## Properties + +BrandingMembers}> +> **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`](/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#branding) + + + +ClientMembers}> +> **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`](/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#client) + + + +OrganizationMembers}> +> **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`](/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#organization) + + + +PromptMembers}> +> **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`](/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#prompt) + + + +TenantMembers}> +> **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`](/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#tenant) + + + +UserMembers}> +> **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`](/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#user) + + + +UntrustedDataMembers}> +> **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`](/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#untrusteddata) + + + +ScreenMembersOnLoginId}> +> **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`](/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#screen) + + + +TransactionMembersOnLoginId}> +> **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`](/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#transaction) + +**Methods** + + + +> **login**(`payload`): `Promise`\<`void`\> + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/login-id.d.ts:51 + +**Parameters** + +**payload** + +[`LoginOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/LoginOptions) + +**Returns** + +`Promise`\<`void`\> + + + + +> **federatedLogin**(`payload`): `Promise`\<`void`\> + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/login-id.d.ts:52 + +**Parameters** + +**payload** + +[`FederatedLoginOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/FederatedLoginOptions) + +**Returns** + +`Promise`\<`void`\> + + + + +> **passkeyLogin**(`payload?`): `Promise`\<`void`\> + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/login-id.d.ts:53 + +**Parameters** + +**payload?** + +[`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CustomOptions) + +**Returns** + +`Promise`\<`void`\> + + + + +> **pickCountryCode**(`payload?`): `Promise`\<`void`\> + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/login-id.d.ts:54 + +**Parameters** + +**payload?** + +[`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CustomOptions) + +**Returns** + +`Promise`\<`void`\> + + + + +> **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`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/type-aliases/IdentifierType)[] \| `null` + 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..f46f008dd --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/LoginMembers.mdx @@ -0,0 +1,190 @@ +--- +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`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers) + +## Properties + +BrandingMembers}> +> **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`](/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#branding) + + + +ClientMembers}> +> **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`](/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#client) + + + +OrganizationMembers}> +> **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`](/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#organization) + + + +PromptMembers}> +> **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`](/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#prompt) + + + +TenantMembers}> +> **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`](/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#tenant) + + + +UserMembers}> +> **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`](/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#user) + + + +UntrustedDataMembers}> +> **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`](/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#untrusteddata) + + + +ScreenMembersOnLogin}> +> **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`](/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#screen) + + + +TransactionMembersOnLogin}> +> **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`](/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#transaction) + +**Methods** + + + +> **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`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/LoginPayloadOptions) + +The login options + +**Returns** + +`Promise`\<`void`\> + + + + +> **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`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/FederatedLoginPayloadOptions) + +The social login options + +**Returns** + +`Promise`\<`void`\> + + + + +> **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`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CustomOptions) + +Optional custom options + +**Returns** + +`Promise`\<`void`\> + + + + +> **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 + +Gets the active identifier types for the login screen + +**Returns** + +[`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 + +**Utility Feature** + 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 + + +> **username**: `string` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/login-id.d.ts:40 + + + + +> `optional` **captcha**: `string` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/login-id.d.ts:41 + 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..e8b371874 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/LoginPasswordMembers.mdx @@ -0,0 +1,142 @@ +--- +title: "LoginPasswordMembers" +--- + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/login-password.d.ts:45 + +- Extends [`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers) + +## Properties + +BrandingMembers}> +> **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`](/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#branding) + + + +ClientMembers}> +> **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`](/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#client) + + + +OrganizationMembers}> +> **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`](/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#organization) + + + +PromptMembers}> +> **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`](/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#prompt) + + + +TenantMembers}> +> **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`](/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#tenant) + + + +UserMembers}> +> **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`](/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#user) + + + +UntrustedDataMembers}> +> **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`](/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#untrusteddata) + + + +ScreenMembersOnLoginPassword}> +> **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`](/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#screen) + + + +TransactionMembersOnLoginPassword}> +> **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`](/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#transaction) + +**Methods** + + + +> **login**(`payload`): `Promise`\<`void`\> + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/login-password.d.ts:48 + +**Parameters** + +**payload** + +[`LoginPasswordOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/LoginPasswordOptions) + +**Returns** + +`Promise`\<`void`\> + + + + +> **federatedLogin**(`payload`): `Promise`\<`void`\> + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/login-password.d.ts:49 + +**Parameters** + +**payload** + +[`FederatedLoginPasswordOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/FederatedLoginPasswordOptions) + +**Returns** + +`Promise`\<`void`\> + 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 + + +> **username**: `string` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/login-password.d.ts:36 + + + + +> **password**: `string` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/login-password.d.ts:37 + + + + +> `optional` **captcha**: `string` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/login-password.d.ts:38 + 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..2623e84e2 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/LoginPasswordlessEmailCodeMembers.mdx @@ -0,0 +1,159 @@ +--- +title: "LoginPasswordlessEmailCodeMembers" +--- + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/login-passwordless-email-code.d.ts:23 + +- Extends [`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers) + +## Properties + +BrandingMembers}> +> **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`](/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#branding) + + + +ClientMembers}> +> **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`](/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#client) + + + +OrganizationMembers}> +> **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`](/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#organization) + + + +PromptMembers}> +> **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`](/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#prompt) + + + +TenantMembers}> +> **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`](/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#tenant) + + + +UserMembers}> +> **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`](/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#user) + + + +UntrustedDataMembers}> +> **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`](/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#untrusteddata) + + + +ScreenMembersOnLoginPasswordlessEmailCode}> +> **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`](/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#screen) + + + +TransactionMembersOnLoginPasswordlessEmailCode}> +> **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`](/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#transaction) + +**Methods** + + + +> **submitCode**(`payload`): `Promise`\<`void`\> + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/login-passwordless-email-code.d.ts:26 + +**Parameters** + +**payload** + +[`SubmitCodeOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/SubmitCodeOptions) + +**Returns** + +`Promise`\<`void`\> + + + + +> **resendCode**(`payload?`): `Promise`\<`void`\> + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/login-passwordless-email-code.d.ts:27 + +**Parameters** + +**payload?** + +[`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CustomOptions) + +**Returns** + +`Promise`\<`void`\> + + + + +> **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 + +**Parameters** + +**options?** + +[`StartResendOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/StartResendOptions) + +**Returns** + +[`ResendControl`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResendControl) + 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..c9d87f333 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/LoginPasswordlessSmsOtpMembers.mdx @@ -0,0 +1,163 @@ +--- +title: "LoginPasswordlessSmsOtpMembers" +--- + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/login-passwordless-sms-otp.d.ts:31 + +- Extends [`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers) + +## Properties + +BrandingMembers}> +> **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`](/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#branding) + + + +ClientMembers}> +> **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`](/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#client) + + + +OrganizationMembers}> +> **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`](/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#organization) + + + +PromptMembers}> +> **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`](/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#prompt) + + + +TenantMembers}> +> **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`](/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#tenant) + + + +UserMembers}> +> **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`](/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#user) + + + +UntrustedDataMembers}> +> **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`](/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#untrusteddata) + + + +ScreenMembersOnLoginPasswordlessSmsOtp}> +> **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`](/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#screen) + + + +TransactionMembersOnLoginPasswordlessSmsOtp}> +> **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`](/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#transaction) + +**Methods** + + + +> **submitOTP**(`payload`): `Promise`\<`void`\> + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/login-passwordless-sms-otp.d.ts:34 + +**Parameters** + +**payload** + +[`SubmitOTPOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/SubmitOTPOptions) + +**Returns** + +`Promise`\<`void`\> + + + + +> **resendOTP**(`payload?`): `Promise`\<`void`\> + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/login-passwordless-sms-otp.d.ts:35 + +**Parameters** + +**payload?** + +[`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CustomOptions) + +**Returns** + +`Promise`\<`void`\> + + + + +> **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 + +Gets resend functionality with timeout management for this screen + +**Parameters** + +**options?** + +[`StartResendOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/StartResendOptions) + +Configuration options for resend functionality + +**Returns** + +[`ResendControl`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResendControl) + 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 + + +> **username**: `string` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/login.d.ts:53 + +The username/email to login with + + + + +> **password**: `string` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/login.d.ts:55 + +The password for authentication + + + + +> `optional` **captcha**: `string` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/login.d.ts:57 + +Optional captcha value if required + 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..908ad2421 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/LogoutAbortedMembers.mdx @@ -0,0 +1,109 @@ +--- +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`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers) + +## Properties + +BrandingMembers}> +> **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`](/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#branding) + + + +ClientMembers}> +> **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`](/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#client) + + + +OrganizationMembers}> +> **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`](/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#organization) + + + +PromptMembers}> +> **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`](/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#prompt) + + + +ScreenMembers}> +> **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`](/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#screen) + + + +TenantMembers}> +> **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`](/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#tenant) + + + +TransactionMembers}> +> **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`](/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#transaction) + + + +UserMembers}> +> **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`](/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#user) + + + +UntrustedDataMembers}> +> **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`](/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#untrusteddata) + 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..78af3439e --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/LogoutCompleteMembers.mdx @@ -0,0 +1,109 @@ +--- +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`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers) + +## Properties + +BrandingMembers}> +> **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`](/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#branding) + + + +ClientMembers}> +> **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`](/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#client) + + + +OrganizationMembers}> +> **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`](/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#organization) + + + +PromptMembers}> +> **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`](/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#prompt) + + + +ScreenMembers}> +> **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`](/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#screen) + + + +TenantMembers}> +> **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`](/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#tenant) + + + +TransactionMembers}> +> **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`](/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#transaction) + + + +UserMembers}> +> **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`](/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#user) + + + +UntrustedDataMembers}> +> **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`](/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#untrusteddata) + 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..697986f94 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/LogoutMembers.mdx @@ -0,0 +1,131 @@ +--- +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`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers) + +## Properties + +BrandingMembers}> +> **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`](/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#branding) + + + +ClientMembers}> +> **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`](/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#client) + + + +OrganizationMembers}> +> **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`](/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#organization) + + + +PromptMembers}> +> **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`](/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#prompt) + + + +ScreenMembers}> +> **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`](/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#screen) + + + +TenantMembers}> +> **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`](/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#tenant) + + + +TransactionMembers}> +> **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`](/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#transaction) + + + +UserMembers}> +> **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`](/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#user) + + + +UntrustedDataMembers}> +> **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`](/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#untrusteddata) + +**Methods** + + + +> **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`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ConfirmLogoutOptions) + +The options containing the action to perform + +**Returns** + +`Promise`\<`void`\> + 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..d6a28183d --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaBeginEnrollOptionsMembers.mdx @@ -0,0 +1,131 @@ +--- +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`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers) + +## Properties + +BrandingMembers}> +> **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`](/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#branding) + + + +ClientMembers}> +> **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`](/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#client) + + + +OrganizationMembers}> +> **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`](/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#organization) + + + +PromptMembers}> +> **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`](/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#prompt) + + + +ScreenMembers}> +> **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`](/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#screen) + + + +TenantMembers}> +> **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`](/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#tenant) + + + +TransactionMembers}> +> **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`](/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#transaction) + + + +UserMembers}> +> **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`](/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#user) + + + +UntrustedDataMembers}> +> **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`](/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#untrusteddata) + +**Methods** + + + +> **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`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaEnrollOptions) + +The enrollment options including the selected factor + +**Returns** + +`Promise`\<`void`\> + 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..87828a4f8 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaCountryCodesMembers.mdx @@ -0,0 +1,152 @@ +--- +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`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers) + +## Properties + +BrandingMembers}> +> **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`](/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#branding) + + + +ClientMembers}> +> **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`](/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#client) + + + +OrganizationMembers}> +> **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`](/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#organization) + + + +PromptMembers}> +> **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`](/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#prompt) + + + +TenantMembers}> +> **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`](/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#tenant) + + + +TransactionMembers}> +> **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`](/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#transaction) + + + +UserMembers}> +> **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`](/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#user) + + + +UntrustedDataMembers}> +> **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`](/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#untrusteddata) + + + +ScreenMembersOnMfaCountryCodes}> +> **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`](/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#screen) + +**Methods** + + + +> **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`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/SelectCountryCodeOptions) + +The options containing the country code selection action + +**Returns** + +`Promise`\<`void`\> + + + + +> **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`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CustomOptions) + +Optional custom options to include with the request + +**Returns** + +`Promise`\<`void`\> + 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..77aa9ef73 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaDetectBrowserCapabilitiesMembers.mdx @@ -0,0 +1,138 @@ +--- +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`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers) + +## Properties + +BrandingMembers}> +> **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`](/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#branding) + + + +ClientMembers}> +> **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`](/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#client) + + + +OrganizationMembers}> +> **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`](/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#organization) + + + +PromptMembers}> +> **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`](/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#prompt) + + + +ScreenMembers}> +> **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`](/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#screen) + + + +TenantMembers}> +> **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`](/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#tenant) + + + +TransactionMembers}> +> **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`](/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#transaction) + + + +UserMembers}> +> **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`](/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#user) + + + +UntrustedDataMembers}> +> **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`](/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#untrusteddata) + +**Methods** + + + +> **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`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CustomOptions) + +The options containing browser capability flags + +**Returns** + +`Promise`\<`void`\> + +**Example** + +```typescript +const mfaDetectBrowserCapabilities = new MfaDetectBrowserCapabilities(); +await mfaDetectBrowserCapabilities.detectCapabilities(); +``` + 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..8753013df --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaEmailChallengeMembers.mdx @@ -0,0 +1,215 @@ +--- +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`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers) + +## Properties + +BrandingMembers}> +> **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`](/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#branding) + + + +ClientMembers}> +> **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`](/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#client) + + + +OrganizationMembers}> +> **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`](/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#organization) + + + +PromptMembers}> +> **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`](/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#prompt) + + + +TenantMembers}> +> **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`](/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#tenant) + + + +TransactionMembers}> +> **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`](/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#transaction) + + + +UserMembers}> +> **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`](/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#user) + + + +ScreenMembersOnMfaEmailChallenge}> +> **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`](/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#screen) + + + +UntrustedDataMembersOnMfaEmailChallenge}> +> **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`](/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#untrusteddata) + +**Methods** + + + +> **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`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ContinuePayloadOptions) + +The options containing the code and rememberDevice flag + +**Returns** + +`Promise`\<`void`\> + + + + +> **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`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResendCodePayloadOptions) + +Optional custom options to include with the request + +**Returns** + +`Promise`\<`void`\> + + + + +> **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`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TryAnotherMethodPayloadOptions) + +Optional custom options to include with the request + +**Returns** + +`Promise`\<`void`\> + + + + +> **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`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CustomOptions) + +Optional custom options to include with the request + +**Returns** + +`Promise`\<`void`\> + + + + +> **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 + +Gets resend functionality with timeout management for this screen + +**Parameters** + +**options?** + +[`StartResendOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/StartResendOptions) + +Configuration options for resend functionality + +**Returns** + +[`ResendControl`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResendControl) + 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..7fc47c265 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaEmailListMembers.mdx @@ -0,0 +1,152 @@ +--- +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`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers) + +## Properties + +BrandingMembers}> +> **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`](/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#branding) + + + +ClientMembers}> +> **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`](/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#client) + + + +OrganizationMembers}> +> **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`](/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#organization) + + + +PromptMembers}> +> **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`](/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#prompt) + + + +TenantMembers}> +> **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`](/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#tenant) + + + +TransactionMembers}> +> **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`](/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#transaction) + + + +UserMembers}> +> **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`](/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#user) + + + +UntrustedDataMembers}> +> **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`](/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#untrusteddata) + + + +ScreenMembersOnMfaEmailList}> +> **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`](/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#screen) + +**Methods** + + + +> **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`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/SelectMfaEmailOptions) + +The options containing the selection action + +**Returns** + +`Promise`\<`void`\> + + + + +> **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`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CustomOptions) + +Optional custom options to include with the request + +**Returns** + +`Promise`\<`void`\> + 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..6164b4920 --- /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 + +MfaEnrollFactorType}> +> **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 + +The action indicating which factor to enroll + 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..3b53a7845 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaEnrollResultMembers.mdx @@ -0,0 +1,111 @@ +--- +title: "MfaEnrollResultMembers" +--- + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/mfa-enroll-result.d.ts:43 + +MfaEnrollResultMembers + +- Extends [`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers) + +## Properties + +BrandingMembers}> +> **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`](/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#branding) + + + +ClientMembers}> +> **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`](/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#client) + + + +OrganizationMembers}> +> **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`](/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#organization) + + + +PromptMembers}> +> **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`](/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#prompt) + + + +TenantMembers}> +> **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`](/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#tenant) + + + +TransactionMembers}> +> **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`](/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#transaction) + + + +UserMembers}> +> **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`](/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#user) + + + +UntrustedDataMembers}> +> **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`](/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#untrusteddata) + + + +ScreenMembersOnMfaEnrollResult}> +> **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 + +Screen-specific data, including enrollment status. + +**Overrides** + +[`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#screen) + 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..340c71645 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaLoginOptionsMembers.mdx @@ -0,0 +1,168 @@ +--- +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`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers) + +## Properties + +BrandingMembers}> +> **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`](/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#branding) + + + +ClientMembers}> +> **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`](/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#client) + + + +OrganizationMembers}> +> **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`](/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#organization) + + + +PromptMembers}> +> **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`](/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#prompt) + + + +TenantMembers}> +> **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`](/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#tenant) + + + +TransactionMembers}> +> **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`](/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#transaction) + + + +UserMembers}> +> **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`](/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#user) + + + +UntrustedDataMembers}> +> **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`](/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#untrusteddata) + + + +ScreenMembersOnMfaLoginOptions}> +> **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`](/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#screen) + +**Methods** + + + +> **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`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/LoginEnrollOptions) + +The options containing the selected factor + +**Returns** + +`Promise`\<`void`\> + +**Example** + +```typescript +const mfaLoginOptions = new MfaLoginOptions(); +await mfaLoginOptions.enroll({ + action: 'push-notification' +}); +``` + + + + +> **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`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CustomOptions) + +Optional custom options + +**Returns** + +`Promise`\<`void`\> + +**Example** + +```typescript +const mfaLoginOptions = new MfaLoginOptions(); +await mfaLoginOptions.returnToPrevious(); +``` + 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..e1ea0da31 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaOtpChallengeMembers.mdx @@ -0,0 +1,152 @@ +--- +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`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers) + +## Properties + +BrandingMembers}> +> **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`](/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#branding) + + + +ClientMembers}> +> **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`](/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#client) + + + +OrganizationMembers}> +> **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`](/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#organization) + + + +PromptMembers}> +> **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`](/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#prompt) + + + +TenantMembers}> +> **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`](/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#tenant) + + + +TransactionMembers}> +> **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`](/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#transaction) + + + +UserMembers}> +> **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`](/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#user) + + + +ScreenMembersOnMfaOtpChallenge}> +> **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`](/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#screen) + + + +UntrustedDataMembersOnMfaOtpChallenge}> +> **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`](/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#untrusteddata) + +**Methods** + + + +> **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`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ContinueOTPOptions) + +The options containing the code and rememberDevice flag + +**Returns** + +`Promise`\<`void`\> + + + + +> **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`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TryAnotherMethodMfaOtpChallengeOptions) + +Optional custom options to include with the request + +**Returns** + +`Promise`\<`void`\> + 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 + + +> **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. + 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..18cd58a11 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaOtpEnrollmentCodeMembers.mdx @@ -0,0 +1,154 @@ +--- +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`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers) + +## Properties + +BrandingMembers}> +> **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`](/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#branding) + + + +ClientMembers}> +> **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`](/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#client) + + + +OrganizationMembers}> +> **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`](/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#organization) + + + +PromptMembers}> +> **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`](/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#prompt) + + + +TenantMembers}> +> **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`](/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#tenant) + + + +TransactionMembers}> +> **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`](/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#transaction) + + + +UserMembers}> +> **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`](/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#user) + + + +UntrustedDataMembers}> +> **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`](/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#untrusteddata) + + + +ScreenMembersOnMfaOtpEnrollmentCode}> +> **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 + +The screen properties for the mfa-otp-enrollment-code screen. + +**Overrides** + +[`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#screen) + +**Methods** + + + +> **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`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaOtpContinueOptions) + +The options containing the OTP code. + +**Returns** + +`Promise`\<`void`\> + + + + +> **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`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaOtpTryAnotherMethodOptions) + +Optional custom options to include with the request. + +**Returns** + +`Promise`\<`void`\> + 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..af4b2c3b6 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaOtpEnrollmentQrContinueOptions.mdx @@ -0,0 +1,21 @@ +--- +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`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CustomOptions) + +## Indexable + +\[`key`: `string`\]: `string` \| `number` \| `boolean` \| `undefined` + +## Properties + + +> **code**: `string` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/mfa-otp-enrollment-qr.d.ts:17 + 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..fb2bd91c1 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaOtpEnrollmentQrMembers.mdx @@ -0,0 +1,173 @@ +--- +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`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers) + +## Properties + +BrandingMembers}> +> **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`](/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#branding) + + + +ClientMembers}> +> **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`](/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#client) + + + +OrganizationMembers}> +> **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`](/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#organization) + + + +PromptMembers}> +> **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`](/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#prompt) + + + +TenantMembers}> +> **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`](/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#tenant) + + + +TransactionMembers}> +> **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`](/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#transaction) + + + +UserMembers}> +> **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`](/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#user) + + + +UntrustedDataMembers}> +> **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`](/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#untrusteddata) + + + +ScreenMembersOnMfaOtpEnrollmentQr}> +> **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`](/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#screen) + +**Methods** + + + +> **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`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CustomOptions) + +Optional custom options to include with the request + +**Returns** + +`Promise`\<`void`\> + + + + +> **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`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaOtpEnrollmentQrContinueOptions) + +Payload containing code and optional custom options + +**Returns** + +`Promise`\<`void`\> + + + + +> **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`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CustomOptions) + +Optional custom options to include with the request + +**Returns** + +`Promise`\<`void`\> + 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..f4499bb8c --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaPhoneChallengeContinueOptions.mdx @@ -0,0 +1,33 @@ +--- +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`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CustomOptions) + +## Indexable + +\[`key`: `string`\]: `string` \| `number` \| `boolean` \| `undefined` + +## Properties + + +> **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' +``` + 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..f63b594f5 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaPhoneChallengeMembers.mdx @@ -0,0 +1,229 @@ +--- +title: "MfaPhoneChallengeMembers" +--- + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/mfa-phone-challenge.d.ts:58 + +MfaPhoneChallengeMembers + +- Extends [`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers) + +## Properties + +BrandingMembers}> +> **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`](/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#branding) + + + +ClientMembers}> +> **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`](/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#client) + + + +OrganizationMembers}> +> **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`](/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#organization) + + + +PromptMembers}> +> **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`](/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#prompt) + + + +TenantMembers}> +> **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`](/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#tenant) + + + +TransactionMembers}> +> **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`](/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#transaction) + + + +UserMembers}> +> **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`](/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#user) + + + +UntrustedDataMembers}> +> **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`](/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#untrusteddata) + + + +ScreenMembersOnMfaPhoneChallenge}> +> **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`](/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#screen) + +**Methods** + + + +> **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`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/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' }); +``` + + + + +> **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`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/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(); +``` + + + + +> **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`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/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(); +``` + 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..4f7e2e7a7 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaPhoneChallengePickAuthenticatorOptions.mdx @@ -0,0 +1,15 @@ +--- +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`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/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/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..bfb1edcf8 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaPhoneChallengePickPhoneOptions.mdx @@ -0,0 +1,16 @@ +--- +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`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/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/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..c96ab5009 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaPhoneEnrollmentContinueOptions.mdx @@ -0,0 +1,30 @@ +--- +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`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CustomOptions) + +## Indexable + +\[`key`: `string`\]: `string` \| `number` \| `boolean` \| `undefined` + +## Properties + + +> **phone**: `string` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/mfa-phone-enrollment.d.ts:14 + + + + +> **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/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..a883ae3e5 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaPhoneEnrollmentMembers.mdx @@ -0,0 +1,171 @@ +--- +title: "MfaPhoneEnrollmentMembers" +--- + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/mfa-phone-enrollment.d.ts:17 + +- Extends [`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers) + +## Properties + +BrandingMembers}> +> **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`](/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#branding) + + + +TenantMembers}> +> **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`](/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#tenant) + + + +UserMembers}> +> **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`](/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#user) + + + +UntrustedDataMembers}> +> **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`](/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#untrusteddata) + + + +ClientMembers}> +> **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`](/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#client) + + + +OrganizationMembers}> +> **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`](/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#organization) + + + +PromptMembers}> +> **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`](/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#prompt) + + + +ScreenMembers}> +> **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`](/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#screen) + + + +TransactionMembers}> +> **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`](/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#transaction) + +**Methods** + + + +> **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`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CustomOptions) + +Optional custom options to include with the request. + +**Returns** + +`Promise`\<`void`\> + + + + +> **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`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaPhoneEnrollmentContinueOptions) + +The phone number, type, and optional custom options. + +**Returns** + +`Promise`\<`void`\> + + + + +> **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`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CustomOptions) + +Optional custom options to include with the request. + +**Returns** + +`Promise`\<`void`\> + 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..beff38263 --- /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/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). + +## Properties + + +> **isRunning**: `boolean` + +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. + +- `true` — Polling is running and awaiting completion. +- `false` — Polling has stopped, either due to completion, + manual cancellation, or component unmount. + + + + +> **startPolling**: () => `void` + +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. + +- If polling is already active, this call has no effect. +- If previously stopped, calling this restarts the polling loop. + +**Returns** + +`void` + + + + +> **stopPolling**: () => `void` + +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. + +- Cancels any scheduled timers or in-flight requests. +- Safe to call multiple times; subsequent calls have no effect. + +**Returns** + +`void` + 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..2e850ef65 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaPushChallengePushMembers.mdx @@ -0,0 +1,217 @@ +--- +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`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers) + +## Properties + +BrandingMembers}> +> **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`](/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#branding) + + + +ClientMembers}> +> **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`](/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#client) + + + +OrganizationMembers}> +> **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`](/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#organization) + + + +PromptMembers}> +> **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`](/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#prompt) + + + +TenantMembers}> +> **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`](/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#tenant) + + + +TransactionMembers}> +> **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`](/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#transaction) + + + +UserMembers}> +> **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`](/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#user) + + + +ScreenMembersOnMfaPushChallengePush}> +> **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`](/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#screen) + + + +UntrustedDataMembersOnMfaPushChallengePush}> +> **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`](/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#untrusteddata) + +**Methods** + + + +> **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`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/WithRememberOptions) + +Optional custom options to include with the request + +**Returns** + +`Promise`\<`void`\> + + + + +> **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`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/WithRememberOptions) + +Optional custom options to include with the request + +**Returns** + +`Promise`\<`void`\> + + + + +> **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`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CustomOptions) + +Optional custom options to include with the request + +**Returns** + +`Promise`\<`void`\> + + + + +> **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`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CustomOptions) + +Optional custom options to include with the request + +**Returns** + +`Promise`\<`void`\> + + + + +> **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 + +Manages polling for MFA push challenge status + +**Parameters** + +**options** + +[`MfaPollingOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/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`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaPushPollingControl) + +An object to control the polling process + 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..f88ff47c7 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaPushEnrollmentQrMembers.mdx @@ -0,0 +1,148 @@ +--- +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`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers) + +## Properties + +BrandingMembers}> +> **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`](/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#branding) + + + +ClientMembers}> +> **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`](/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#client) + + + +OrganizationMembers}> +> **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`](/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#organization) + + + +PromptMembers}> +> **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`](/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#prompt) + + + +TenantMembers}> +> **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`](/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#tenant) + + + +TransactionMembers}> +> **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`](/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#transaction) + + + +UserMembers}> +> **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`](/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#user) + + + +UntrustedDataMembers}> +> **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`](/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#untrusteddata) + + + +ScreenMembersOnMfaPushEnrollmentQr}> +> **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`](/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#screen) + +**Methods** + + + +> **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`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CustomOptions) + +Optional custom options to include with the request + +**Returns** + +`Promise`\<`void`\> + + + + +> **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 + +**Parameters** + +**options** + +[`MfaPollingOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/type-aliases/MfaPollingOptions) + +**Returns** + +[`MfaPushPollingControl`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaPushPollingControl) + 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..82bc11184 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaPushListMembers.mdx @@ -0,0 +1,152 @@ +--- +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`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers) + +## Properties + +BrandingMembers}> +> **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`](/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#branding) + + + +ClientMembers}> +> **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`](/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#client) + + + +OrganizationMembers}> +> **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`](/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#organization) + + + +PromptMembers}> +> **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`](/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#prompt) + + + +ScreenMembers}> +> **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`](/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#screen) + + + +TenantMembers}> +> **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`](/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#tenant) + + + +TransactionMembers}> +> **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`](/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#transaction) + + + +UserMembers}> +> **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`](/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#user) + + + +UntrustedDataMembers}> +> **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`](/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#untrusteddata) + +**Methods** + + + +> **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`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/SelectMfaPushDeviceOptions) + +The options containing the device index. + +**Returns** + +`Promise`\<`void`\> + + + + +> **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`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CustomOptions) + +Optional custom options to include with the request. + +**Returns** + +`Promise`\<`void`\> + 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..74b162694 --- /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 + + +> **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(); +``` + + + + +> **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 +``` + + + + +> **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.'); +} +``` + 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..3e7153ae4 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaPushWelcomeMembers.mdx @@ -0,0 +1,142 @@ +--- +title: "MfaPushWelcomeMembers" +--- + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/mfa-push-welcome.d.ts:16 + +- Extends [`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers) + +## Properties + +BrandingMembers}> +> **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`](/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#branding) + + + +ClientMembers}> +> **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`](/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#client) + + + +OrganizationMembers}> +> **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`](/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#organization) + + + +PromptMembers}> +> **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`](/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#prompt) + + + +TenantMembers}> +> **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`](/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#tenant) + + + +TransactionMembers}> +> **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`](/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#transaction) + + + +UserMembers}> +> **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`](/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#user) + + + +UntrustedDataMembers}> +> **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`](/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#untrusteddata) + + + +ScreenMembersOnMfaPushWelcome}> +> **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`](/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#screen) + +**Methods** + + + +> **enroll**(`payload?`): `Promise`\<`void`\> + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/mfa-push-welcome.d.ts:18 + +**Parameters** + +**payload?** + +[`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CustomOptions) + +**Returns** + +`Promise`\<`void`\> + + + + +> **pickAuthenticator**(`payload?`): `Promise`\<`void`\> + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/mfa-push-welcome.d.ts:19 + +**Parameters** + +**payload?** + +[`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CustomOptions) + +**Returns** + +`Promise`\<`void`\> + 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..dbf12ca6d --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaRecoveryCodeChallengeContinueOptions.mdx @@ -0,0 +1,21 @@ +--- +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`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CustomOptions) + +## Indexable + +\[`key`: `string`\]: `string` \| `number` \| `boolean` \| `undefined` + +## Properties + + +> **code**: `string` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/mfa-recovery-code-challenge.d.ts:12 + 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..15f142fe4 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaRecoveryCodeChallengeMembers.mdx @@ -0,0 +1,156 @@ +--- +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`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers) + +## Properties + +BrandingMembers}> +> **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`](/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#branding) + + + +TenantMembers}> +> **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`](/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#tenant) + + + +UserMembers}> +> **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`](/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#user) + + + +UntrustedDataMembers}> +> **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`](/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#untrusteddata) + + + +ClientMembers}> +> **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`](/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#client) + + + +OrganizationMembers}> +> **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`](/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#organization) + + + +PromptMembers}> +> **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`](/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#prompt) + + + +ScreenMembers}> +> **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`](/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#screen) + + + +TransactionMembers}> +> **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`](/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#transaction) + +**Methods** + + + +> **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`](/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. + +**Returns** + +`Promise`\<`void`\> + +A promise that resolves when the continuation is successful. + + + + +> **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`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CustomOptions) + +Optional payload. + +**Returns** + +`Promise`\<`void`\> + +A promise that resolves when the navigation is complete. + 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..25db891f1 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaRecoveryCodeChallengeNewCodeContinueOptions.mdx @@ -0,0 +1,13 @@ +--- +title: "MfaRecoveryCodeChallengeNewCodeContinueOptions" +--- + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/mfa-recovery-code-challenge-new-code.d.ts:30 + +ContinueOptions + +- Extends [`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/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/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..0ad7da729 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaRecoveryCodeChallengeNewCodeMembers.mdx @@ -0,0 +1,159 @@ +--- +title: "MfaRecoveryCodeChallengeNewCodeMembers" +--- + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/mfa-recovery-code-challenge-new-code.d.ts:39 + +MfaRecoveryCodeChallengeNewCodeMembers + +- Extends [`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers) + +## Properties + +BrandingMembers}> +> **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`](/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#branding) + + + +ClientMembers}> +> **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`](/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#client) + + + +OrganizationMembers}> +> **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`](/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#organization) + + + +PromptMembers}> +> **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`](/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#prompt) + + + +TenantMembers}> +> **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`](/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#tenant) + + + +TransactionMembers}> +> **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`](/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#transaction) + + + +UserMembers}> +> **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`](/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#user) + + + +UntrustedDataMembers}> +> **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`](/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#untrusteddata) + + + +ScreenMembersOnMfaRecoveryCodeChallengeNewCode}> +> **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 + +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/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`screen`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers#screen) + +**Methods** + + + +> **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`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/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 +} +``` + 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..a2b4fa8cc --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaRecoveryCodeEnrollmentContinueOptions.mdx @@ -0,0 +1,19 @@ +--- +title: "MfaRecoveryCodeEnrollmentContinueOptions" +--- + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/mfa-recovery-code-enrollment.d.ts:15 + +- Extends [`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CustomOptions) + +## Indexable + +\[`key`: `string`\]: `string` \| `number` \| `boolean` \| `undefined` + +## Properties + + +> **isCodeCopied**: `boolean` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/mfa-recovery-code-enrollment.d.ts:16 + 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..16d6f187c --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaRecoveryCodeEnrollmentMembers.mdx @@ -0,0 +1,136 @@ +--- +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`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers) + +## Properties + +BrandingMembers}> +> **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`](/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#branding) + + + +ClientMembers}> +> **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`](/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#client) + + + +OrganizationMembers}> +> **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`](/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#organization) + + + +PromptMembers}> +> **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`](/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#prompt) + + + +TenantMembers}> +> **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`](/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#tenant) + + + +TransactionMembers}> +> **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`](/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#transaction) + + + +UserMembers}> +> **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`](/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#user) + + + +UntrustedDataMembers}> +> **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`](/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#untrusteddata) + + + +ScreenMembersOnMfaRecoveryCodeEnrollment}> +> **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`](/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#screen) + +**Methods** + + + +> **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`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/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. + 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..9af052882 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaSmsChallengeMembers.mdx @@ -0,0 +1,214 @@ +--- +title: "MfaSmsChallengeMembers" +--- + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/mfa-sms-challenge.d.ts:30 + +- Extends [`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers) + +## Properties + +BrandingMembers}> +> **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`](/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#branding) + + + +ClientMembers}> +> **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`](/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#client) + + + +OrganizationMembers}> +> **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`](/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#organization) + + + +PromptMembers}> +> **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`](/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#prompt) + + + +TenantMembers}> +> **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`](/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#tenant) + + + +TransactionMembers}> +> **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`](/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#transaction) + + + +UserMembers}> +> **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`](/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#user) + + + +ScreenMembersOnMfaSmsChallenge}> +> **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`](/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#screen) + + + +UntrustedDataMembersOnMfaSmsChallenge}> +> **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`](/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#untrusteddata) + +**Methods** + + + +> **continueMfaSmsChallenge**(`payload`): `Promise`\<`void`\> + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/mfa-sms-challenge.d.ts:33 + +**Parameters** + +**payload** + +[`MfaSmsChallengeOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaSmsChallengeOptions) + +**Returns** + +`Promise`\<`void`\> + + + + +> **pickSms**(`payload?`): `Promise`\<`void`\> + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/mfa-sms-challenge.d.ts:34 + +**Parameters** + +**payload?** + +[`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CustomOptions) + +**Returns** + +`Promise`\<`void`\> + + + + +> **resendCode**(`payload?`): `Promise`\<`void`\> + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/mfa-sms-challenge.d.ts:35 + +**Parameters** + +**payload?** + +[`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CustomOptions) + +**Returns** + +`Promise`\<`void`\> + + + + +> **tryAnotherMethod**(`payload?`): `Promise`\<`void`\> + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/mfa-sms-challenge.d.ts:36 + +**Parameters** + +**payload?** + +[`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CustomOptions) + +**Returns** + +`Promise`\<`void`\> + + + + +> **getACall**(`payload?`): `Promise`\<`void`\> + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/mfa-sms-challenge.d.ts:37 + +**Parameters** + +**payload?** + +[`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CustomOptions) + +**Returns** + +`Promise`\<`void`\> + + + + +> **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 + +Gets resend functionality with timeout management for this screen + +**Parameters** + +**options?** + +[`StartResendOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/StartResendOptions) + +Configuration options for resend functionality + +**Returns** + +[`ResendControl`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResendControl) + 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 + + +> **code**: `string` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/mfa-sms-challenge.d.ts:7 + + + + +> `optional` **rememberDevice**: `boolean` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/mfa-sms-challenge.d.ts:8 + 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..b9b5136a1 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaSmsEnrollmentMembers.mdx @@ -0,0 +1,165 @@ +--- +title: "MfaSmsEnrollmentMembers" +--- + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/mfa-sms-enrollment.d.ts:14 + +- Extends [`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers) + +## Properties + +BrandingMembers}> +> **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`](/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#branding) + + + +ClientMembers}> +> **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`](/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#client) + + + +OrganizationMembers}> +> **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`](/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#organization) + + + +PromptMembers}> +> **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`](/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#prompt) + + + +TenantMembers}> +> **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`](/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#tenant) + + + +TransactionMembers}> +> **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`](/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#transaction) + + + +UserMembers}> +> **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`](/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#user) + + + +UntrustedDataMembers}> +> **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`](/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#untrusteddata) + + + +ScreenMembersOnMfaSmsEnrollment}> +> **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`](/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#screen) + +**Methods** + + + +> **pickCountryCode**(`payload?`): `Promise`\<`void`\> + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/mfa-sms-enrollment.d.ts:16 + +**Parameters** + +**payload?** + +[`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CustomOptions) + +**Returns** + +`Promise`\<`void`\> + + + + +> **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`\> + + + + +> **tryAnotherMethod**(`payload?`): `Promise`\<`void`\> + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/mfa-sms-enrollment.d.ts:21 + +**Parameters** + +**payload?** + +[`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CustomOptions) + +**Returns** + +`Promise`\<`void`\> + 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 + + +> `optional` **phone**: `string` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/mfa-sms-enrollment.d.ts:5 + + + + +> `optional` **captcha**: `string` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/mfa-sms-enrollment.d.ts:6 + 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..651bd311c --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaSmsListMembers.mdx @@ -0,0 +1,157 @@ +--- +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`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers) + +## Properties + +BrandingMembers}> +> **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`](/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#branding) + + + +ClientMembers}> +> **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`](/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#client) + + + +OrganizationMembers}> +> **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`](/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#organization) + + + +PromptMembers}> +> **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`](/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#prompt) + + + +ScreenMembers}> +> **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`](/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#screen) + + + +TenantMembers}> +> **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`](/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#tenant) + + + +TransactionMembers}> +> **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`](/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#transaction) + + + +UserMembers}> +> **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`](/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#user) + + + +UntrustedDataMembers}> +> **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`](/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#untrusteddata) + +**Methods** + + + +> **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`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaSmsListOptions) + +Optional payload for the action. + +**Returns** + +`Promise`\<`void`\> + +**Throws** + +If the index is out of bounds. + + + + +> **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`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CustomOptions) + +Optional payload for the action. + +**Returns** + +`Promise`\<`void`\> + 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 + + +> **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. + 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 + + +> **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. + + + + +> `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. + 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..af614c18c --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaVoiceChallengeMembers.mdx @@ -0,0 +1,286 @@ +--- +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`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers) + +## Properties + +BrandingMembers}> +> **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`](/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#branding) + + + +ClientMembers}> +> **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`](/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#client) + + + +OrganizationMembers}> +> **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`](/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#organization) + + + +PromptMembers}> +> **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`](/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#prompt) + + + +TenantMembers}> +> **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`](/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#tenant) + + + +TransactionMembers}> +> **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`](/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#transaction) + + + +UserMembers}> +> **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`](/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#user) + + + +ScreenMembersOnMfaVoiceChallenge}> +> **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 + +Screen-specific properties and data. + +**Overrides** + +[`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#screen) + + + +UntrustedDataMembersOnMfaVoiceChallenge}> +> **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`](/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#untrusteddata) + +**Methods** + + + +> **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`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/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 +}); +``` + + + + +> **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`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CustomOptions) + +Optional custom parameters + +**Returns** + +`Promise`\<`void`\> + +Promise that resolves when navigation is complete + +**Example** + +```typescript +const mfaVoiceChallenge = new MfaVoiceChallenge(); +mfaVoiceChallenge.pickPhone(); +``` + + + + +> **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`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CustomOptions) + +Optional custom parameters + +**Returns** + +`Promise`\<`void`\> + +Promise that resolves when switching is complete + +**Example** + +```typescript +const mfaVoiceChallenge = new MfaVoiceChallenge(); +mfaVoiceChallenge.switchToSms(); +``` + + + + +> **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`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CustomOptions) + +Optional custom parameters + +**Returns** + +`Promise`\<`void`\> + +Promise that resolves when the new code is sent + +**Example** + +```typescript +const mfaVoiceChallenge = new MfaVoiceChallenge(); +mfaVoiceChallenge.resendCode(); +``` + + + + +> **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`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CustomOptions) + +Optional custom parameters + +**Returns** + +`Promise`\<`void`\> + +Promise that resolves when navigation is complete + +**Example** + +```typescript +const mfaVoiceChallenge = new MfaVoiceChallenge(); +mfaVoiceChallenge.tryAnotherMethod(); +``` + + + + +> **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 + +Gets resend functionality with timeout management for this screen + +**Parameters** + +**options?** + +[`StartResendOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/StartResendOptions) + +Configuration options for resend functionality + +**Returns** + +[`ResendControl`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResendControl) + 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..31a484328 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaVoiceEnrollmentContinueOptions.mdx @@ -0,0 +1,21 @@ +--- +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`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CustomOptions) + +## Indexable + +\[`key`: `string`\]: `string` \| `number` \| `boolean` \| `undefined` + +## Properties + + +> **phone**: `string` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/mfa-voice-enrollment.d.ts:12 + 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..942725d81 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaVoiceEnrollmentMembers.mdx @@ -0,0 +1,179 @@ +--- +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`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers) + +## Properties + +BrandingMembers}> +> **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`](/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#branding) + + + +TenantMembers}> +> **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`](/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#tenant) + + + +UserMembers}> +> **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`](/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#user) + + + +UntrustedDataMembers}> +> **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`](/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#untrusteddata) + + + +ClientMembers}> +> **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`](/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#client) + + + +OrganizationMembers}> +> **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`](/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#organization) + + + +PromptMembers}> +> **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`](/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#prompt) + + + +ScreenMembers}> +> **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`](/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#screen) + + + +TransactionMembers}> +> **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`](/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#transaction) + +**Methods** + + + +> **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`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaVoiceEnrollmentContinueOptions) + +The phone number and optional custom options. + +**Returns** + +`Promise`\<`void`\> + +Promise that resolves when enrollment continues. + + + + +> **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`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CustomOptions) + +Optional custom options. + +**Returns** + +`Promise`\<`void`\> + +Promise that resolves when the user switches method. + + + + +> **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`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CustomOptions) + +Optional custom options. + +**Returns** + +`Promise`\<`void`\> + +Promise that resolves when the country code is selected. + 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..bff9a5a40 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaWebAuthnChangeKeyNicknameContinueOptions.mdx @@ -0,0 +1,25 @@ +--- +title: "MfaWebAuthnChangeKeyNicknameContinueOptions" +--- + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/mfa-webauthn-change-key-nickname.d.ts:41 + +ContinueOptions + +- Extends [`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CustomOptions) + +## Indexable + +\[`key`: `string`\]: `string` \| `number` \| `boolean` \| `undefined` + +## Properties + + +> **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. + 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..108d00964 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaWebAuthnChangeKeyNicknameMembers.mdx @@ -0,0 +1,176 @@ +--- +title: "MfaWebAuthnChangeKeyNicknameMembers" +--- + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/mfa-webauthn-change-key-nickname.d.ts:67 + +MfaWebAuthnChangeKeyNicknameMembers + +- Extends [`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers) + +## Properties + +BrandingMembers}> +> **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`](/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#branding) + + + +ClientMembers}> +> **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`](/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#client) + + + +OrganizationMembers}> +> **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`](/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#organization) + + + +PromptMembers}> +> **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`](/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#prompt) + + + +TenantMembers}> +> **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`](/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#tenant) + + + +TransactionMembers}> +> **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`](/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#transaction) + + + +UserMembers}> +> **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`](/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#user) + + + +UntrustedDataMembers}> +> **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`](/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#untrusteddata) + + + +ScreenMembersOnMfaWebAuthnChangeKeyNickname}> +> **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 + +The screen object with MFA WebAuthn Change Key Nickname specific data structure. + +**Overrides** + +[`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#screen) + +**Methods** + + + +> **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`](/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. + +**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" + } + }); +} +``` + 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..3d2c124eb --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaWebAuthnEnrollmentSuccessMembers.mdx @@ -0,0 +1,156 @@ +--- +title: "MfaWebAuthnEnrollmentSuccessMembers" +--- + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/mfa-webauthn-enrollment-success.d.ts:53 + +MfaWebAuthnEnrollmentSuccessMembers + +- Extends [`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers) + +## Properties + +BrandingMembers}> +> **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`](/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#branding) + + + +ClientMembers}> +> **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`](/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#client) + + + +OrganizationMembers}> +> **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`](/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#organization) + + + +PromptMembers}> +> **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`](/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#prompt) + + + +TenantMembers}> +> **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`](/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#tenant) + + + +TransactionMembers}> +> **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`](/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#transaction) + + + +UserMembers}> +> **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`](/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#user) + + + +UntrustedDataMembers}> +> **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`](/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#untrusteddata) + + + +ScreenMembersOnMfaWebAuthnEnrollmentSuccess}> +> **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 + +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/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`screen`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers#screen) + +**Methods** + + + +> **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`](/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. + +**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. +} +``` + 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..8665a226c --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaWebAuthnErrorMembers.mdx @@ -0,0 +1,252 @@ +--- +title: "MfaWebAuthnErrorMembers" +--- + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/mfa-webauthn-error.d.ts:43 + +MfaWebAuthnErrorMembers + +- Extends [`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers) + +## Properties + +BrandingMembers}> +> **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`](/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#branding) + + + +ClientMembers}> +> **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`](/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#client) + + + +OrganizationMembers}> +> **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`](/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#organization) + + + +PromptMembers}> +> **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`](/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#prompt) + + + +TenantMembers}> +> **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`](/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#tenant) + + + +TransactionMembers}> +> **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`](/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#transaction) + + + +UserMembers}> +> **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`](/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#user) + + + +UntrustedDataMembers}> +> **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`](/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#untrusteddata) + + + +ScreenMembersOnMfaWebAuthnError}> +> **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 + +The screen object with MFA WebAuthn Error specific data structure. + +**Overrides** + +[`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#screen) + +**Methods** + + + +> **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`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/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(); +``` + + + + +> **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`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/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(); +``` + + + + +> **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`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/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(); +``` + + + + +> **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`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/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(); +``` + 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..ae77188b2 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaWebAuthnNotAvailableErrorMembers.mdx @@ -0,0 +1,152 @@ +--- +title: "MfaWebAuthnNotAvailableErrorMembers" +--- + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/mfa-webauthn-not-available-error.d.ts:13 + +MfaWebAuthnNotAvailableErrorMembers + +- Extends [`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers) + +## Properties + +BrandingMembers}> +> **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`](/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#branding) + + + +ClientMembers}> +> **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`](/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#client) + + + +OrganizationMembers}> +> **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`](/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#organization) + + + +PromptMembers}> +> **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`](/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#prompt) + + + +ScreenMembers}> +> **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`](/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#screen) + + + +TenantMembers}> +> **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`](/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#tenant) + + + +TransactionMembers}> +> **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`](/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#transaction) + + + +UserMembers}> +> **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`](/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#user) + + + +UntrustedDataMembers}> +> **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`](/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#untrusteddata) + +**Methods** + + + +> **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`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/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. +} +``` + 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..1424e9f6e --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaWebAuthnPlatformChallengeMembers.mdx @@ -0,0 +1,254 @@ +--- +title: "MfaWebAuthnPlatformChallengeMembers" +--- + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/mfa-webauthn-platform-challenge.d.ts:75 + +MfaWebAuthnPlatformChallengeMembers + +- Extends [`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers) + +## Properties + +BrandingMembers}> +> **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`](/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#branding) + + + +ClientMembers}> +> **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`](/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#client) + + + +OrganizationMembers}> +> **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`](/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#organization) + + + +PromptMembers}> +> **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`](/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#prompt) + + + +TenantMembers}> +> **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`](/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#tenant) + + + +TransactionMembers}> +> **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`](/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#transaction) + + + +UserMembers}> +> **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`](/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#user) + + + +UntrustedDataMembers}> +> **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`](/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#untrusteddata) + + + +ScreenMembersOnMfaWebAuthnPlatformChallenge}> +> **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 + +Screen-specific properties and data, including WebAuthn challenge options and remember device preference. + +**Overrides** + +[`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#screen) + +**Methods** + + + +> **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`](/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. + +**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. +} +``` + + + + +> **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`](/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. + +**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); +} +``` + + + + +> **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`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/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); +} +``` + 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..933c40187 --- /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 + +WebAuthnErrorDetails}> +> **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 + +The error object from the WebAuthn API (`navigator.credentials.get()`) to be reported. + 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..3ba0a53a4 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaWebAuthnPlatformChallengeTryAnotherMethodOptions.mdx @@ -0,0 +1,13 @@ +--- +title: "MfaWebAuthnPlatformChallengeTryAnotherMethodOptions" +--- + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/mfa-webauthn-platform-challenge.d.ts:67 + +TryAnotherMethodOptions + +- Extends [`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/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/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..8c8e24254 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaWebAuthnPlatformEnrollmentMembers.mdx @@ -0,0 +1,273 @@ +--- +title: "MfaWebAuthnPlatformEnrollmentMembers" +--- + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/mfa-webauthn-platform-enrollment.d.ts:51 + +MfaWebAuthnPlatformEnrollmentMembers + +- Extends [`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers) + +## Properties + +BrandingMembers}> +> **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`](/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#branding) + + + +ClientMembers}> +> **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`](/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#client) + + + +OrganizationMembers}> +> **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`](/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#organization) + + + +PromptMembers}> +> **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`](/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#prompt) + + + +TenantMembers}> +> **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`](/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#tenant) + + + +TransactionMembers}> +> **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`](/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#transaction) + + + +UserMembers}> +> **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`](/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#user) + + + +UntrustedDataMembers}> +> **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`](/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#untrusteddata) + + + +ScreenMembersOnMfaWebAuthnPlatformEnrollment}> +> **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 + +The screen object with MFA WebAuthn Platform Enrollment specific data structure. + +**Overrides** + +[`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#screen) + +**Methods** + + + +> **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`](/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. + +**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 } }); + } +} +``` + + + + +> **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`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/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 +} +``` + + + + +> **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`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/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(); +``` + + + + +> **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`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/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(); +``` + 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..abcd27725 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaWebAuthnRoamingChallengeMembers.mdx @@ -0,0 +1,247 @@ +--- +title: "MfaWebAuthnRoamingChallengeMembers" +--- + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/mfa-webauthn-roaming-challenge.d.ts:56 + +MfaWebAuthnRoamingChallengeMembers + +- Extends [`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers) + +## Properties + +BrandingMembers}> +> **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`](/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#branding) + + + +ClientMembers}> +> **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`](/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#client) + + + +OrganizationMembers}> +> **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`](/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#organization) + + + +PromptMembers}> +> **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`](/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#prompt) + + + +TenantMembers}> +> **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`](/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#tenant) + + + +TransactionMembers}> +> **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`](/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#transaction) + + + +UserMembers}> +> **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`](/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#user) + + + +UntrustedDataMembers}> +> **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`](/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#untrusteddata) + + + +ScreenMembersOnMfaWebAuthnRoamingChallenge}> +> **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 + +Screen-specific properties and data, including WebAuthn challenge options. + +**Overrides** + +[`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#screen) + +**Methods** + + + +> **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`](/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. + +**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. +} +``` + + + + +> **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`](/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. + +**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); +} +``` + + + + +> **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`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/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); +} +``` + 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..ed0ebf2ed --- /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 + +WebAuthnErrorDetails}> +> **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 + +The error object from the WebAuthn API to be reported. + 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..e01346fa8 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaWebAuthnRoamingChallengeTryAnotherMethodOptions.mdx @@ -0,0 +1,13 @@ +--- +title: "MfaWebAuthnRoamingChallengeTryAnotherMethodOptions" +--- + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/mfa-webauthn-roaming-challenge.d.ts:48 + +TryAnotherMethodOptions + +- Extends [`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/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/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..e64e77085 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaWebAuthnRoamingEnrollmentMembers.mdx @@ -0,0 +1,224 @@ +--- +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`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers) + +## Properties + +BrandingMembers}> +> **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`](/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#branding) + + + +ClientMembers}> +> **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`](/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#client) + + + +OrganizationMembers}> +> **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`](/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#organization) + + + +PromptMembers}> +> **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`](/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#prompt) + + + +TenantMembers}> +> **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`](/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#tenant) + + + +TransactionMembers}> +> **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`](/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#transaction) + + + +UserMembers}> +> **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`](/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#user) + + + +UntrustedDataMembers}> +> **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`](/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#untrusteddata) + + + +ScreenMembersOnMfaWebAuthnRoamingEnrollment}> +> **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`](/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#screen) + +**Methods** + + + +> **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`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/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 } }); +} +``` + + + + +> **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`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/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 +``` + + + + +> **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`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/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(); +``` + 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..17826700d --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationMembers.mdx @@ -0,0 +1,51 @@ +--- +title: "OrganizationMembers" +--- + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/organization.d.ts:24 + +## Properties + + +> **id**: `string` \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/organization.d.ts:25 + + + + +> **name**: `string` \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/organization.d.ts:26 + + + + +> **usage**: `string` \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/organization.d.ts:27 + + + + +> **displayName**: `string` \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/organization.d.ts:28 + + + +Branding}> +> **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 new file mode 100644 index 000000000..2400ee0cb --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationPickerMembers.mdx @@ -0,0 +1,158 @@ +--- +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`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers) + +## Properties + +BrandingMembers}> +> **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`](/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#branding) + + + +ClientMembers}> +> **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`](/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#client) + + + +OrganizationMembers}> +> **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`](/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#organization) + + + +PromptMembers}> +> **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`](/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#prompt) + + + +ScreenMembers}> +> **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`](/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#screen) + + + +TenantMembers}> +> **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`](/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#tenant) + + + +TransactionMembers}> +> **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`](/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#transaction) + + + +UserMembers}> +> **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`](/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#user) + + + +UntrustedDataMembers}> +> **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`](/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#untrusteddata) + +**Methods** + + + +> **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`\> + + + + +> **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`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CustomOptions) + +Optional custom options to include with the request. + +**Returns** + +`Promise`\<`void`\> + 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..cd9c54d1f --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OrganizationSelectionMembers.mdx @@ -0,0 +1,133 @@ +--- +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`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers) + +## Properties + +BrandingMembers}> +> **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`](/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#branding) + + + +ClientMembers}> +> **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`](/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#client) + + + +OrganizationMembers}> +> **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`](/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#organization) + + + +PromptMembers}> +> **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`](/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#prompt) + + + +TenantMembers}> +> **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`](/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#tenant) + + + +TransactionMembers}> +> **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`](/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#transaction) + + + +UserMembers}> +> **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`](/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#user) + + + +UntrustedDataMembers}> +> **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`](/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#untrusteddata) + + + +ScreenMembersOnOrganizationSelection}> +> **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 + +The screen properties. + +**Overrides** + +[`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#screen) + +**Methods** + + + +> **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`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ContinueWithOrganizationNameOptions) + +The options containing the organization name. + +**Returns** + +`Promise`\<`void`\> + 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..f4157581a --- /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 + + +> **organizationId**: `string` \| `undefined` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/user.d.ts:29 + + + + +> **organizationName**: `string` \| `undefined` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/user.d.ts:30 + + + + +> **displayName**: `string` \| `undefined` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/user.d.ts:31 + + + +Branding}> +> **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 + 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..6f0aad25e --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/OtpCodeOptions.mdx @@ -0,0 +1,21 @@ +--- +title: "OtpCodeOptions" +--- + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/email-otp-challenge.d.ts:11 + +- Extends [`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CustomOptions) + +## Indexable + +\[`key`: `string`\]: `string` \| `number` \| `boolean` \| `undefined` + +## Properties + + +> **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. + 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..f5c3623f6 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PasskeyCreate.mdx @@ -0,0 +1,49 @@ +--- +title: "PasskeyCreate" +--- + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:19 + +## Properties + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + 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..32ea5c61e --- /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 + + +> **id**: `string` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/utils/passkeys.d.ts:20 + + + + +> **rawId**: `string` \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/utils/passkeys.d.ts:21 + + + + +> **type**: `string` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/utils/passkeys.d.ts:22 + + + + +> **authenticatorAttachment**: `string` \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/utils/passkeys.d.ts:23 + + + +CredentialResponse}> +> **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 + 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..093a2c373 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PasskeyEnrollmentLocalMembers.mdx @@ -0,0 +1,142 @@ +--- +title: "PasskeyEnrollmentLocalMembers" +--- + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/passkey-enrollment-local.d.ts:22 + +- Extends [`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers) + +## Properties + +BrandingMembers}> +> **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`](/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#branding) + + + +ClientMembers}> +> **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`](/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#client) + + + +OrganizationMembers}> +> **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`](/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#organization) + + + +PromptMembers}> +> **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`](/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#prompt) + + + +TenantMembers}> +> **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`](/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#tenant) + + + +TransactionMembers}> +> **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`](/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#transaction) + + + +UserMembers}> +> **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`](/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#user) + + + +UntrustedDataMembers}> +> **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`](/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#untrusteddata) + + + +ScreenMembersOnPasskeyEnrollmentLocal}> +> **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`](/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#screen) + +**Methods** + + + +> **continuePasskeyEnrollment**(`payload?`): `Promise`\<`void`\> + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/passkey-enrollment-local.d.ts:24 + +**Parameters** + +**payload?** + +[`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CustomOptions) + +**Returns** + +`Promise`\<`void`\> + + + + +> **abortPasskeyEnrollment**(`payload`): `Promise`\<`void`\> + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/passkey-enrollment-local.d.ts:25 + +**Parameters** + +**payload** + +[`AbortEnrollmentOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/AbortEnrollmentOptions) + +**Returns** + +`Promise`\<`void`\> + 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..654f62b99 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PasskeyEnrollmentMembers.mdx @@ -0,0 +1,142 @@ +--- +title: "PasskeyEnrollmentMembers" +--- + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/passkey-enrollment.d.ts:20 + +- Extends [`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers) + +## Properties + +BrandingMembers}> +> **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`](/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#branding) + + + +ClientMembers}> +> **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`](/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#client) + + + +OrganizationMembers}> +> **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`](/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#organization) + + + +PromptMembers}> +> **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`](/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#prompt) + + + +TenantMembers}> +> **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`](/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#tenant) + + + +TransactionMembers}> +> **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`](/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#transaction) + + + +UserMembers}> +> **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`](/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#user) + + + +UntrustedDataMembers}> +> **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`](/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#untrusteddata) + + + +ScreenMembersOnPasskeyEnrollment}> +> **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`](/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#screen) + +**Methods** + + + +> **continuePasskeyEnrollment**(`payload?`): `Promise`\<`void`\> + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/passkey-enrollment.d.ts:22 + +**Parameters** + +**payload?** + +[`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CustomOptions) + +**Returns** + +`Promise`\<`void`\> + + + + +> **abortPasskeyEnrollment**(`payload?`): `Promise`\<`void`\> + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/passkey-enrollment.d.ts:23 + +**Parameters** + +**payload?** + +[`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CustomOptions) + +**Returns** + +`Promise`\<`void`\> + 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..092b586c5 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PasswordComplexityRule.mdx @@ -0,0 +1,50 @@ +--- +title: "PasswordComplexityRule" +--- + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/transaction.d.ts:125 + +## Properties + + +> **code**: `string` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/transaction.d.ts:126 + + + + +> **label**: `string` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/transaction.d.ts:127 + + + + +> **status**: `"valid"` \| `"error"` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/transaction.d.ts:128 + + + + +> **isValid**: `boolean` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/transaction.d.ts:129 + + + + + + + + + + + + + +> `optional` **items**: `PasswordComplexityRule`[] + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/transaction.d.ts:135 + 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..eebe4d106 --- /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 + + +> `optional` **enabled**: `boolean` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/transaction.d.ts:52 + + + + +> `optional` **minLength**: `number` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/transaction.d.ts:53 + + + + +> **policy**: `"none"` \| `"low"` \| `"fair"` \| `"good"` \| `"excellent"` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/transaction.d.ts:54 + + + +PasswordComplexityRule[]}> +> `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 new file mode 100644 index 000000000..8585e15b6 --- /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 + + +> **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](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PasswordComplexityRule) has `status` equal to `"valid"`. + + + +PasswordComplexityRule[]}> +> **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](/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#status) field reflects the +computed validation result for that rule. + 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 + + +> **code**: `string` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/phone-identifier-challenge.d.ts:6 + + + + +> `optional` **captcha**: `string` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/phone-identifier-challenge.d.ts:7 + 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..ad611658b --- /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 + + +> **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/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..61ec169d0 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PhoneIdentifierChallengeMembers.mdx @@ -0,0 +1,210 @@ +--- +title: "PhoneIdentifierChallengeMembers" +--- + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/phone-identifier-challenge.d.ts:31 + +- Extends [`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers) + +## Properties + +BrandingMembers}> +> **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`](/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#branding) + + + +ClientMembers}> +> **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`](/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#client) + + + +OrganizationMembers}> +> **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`](/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#organization) + + + +PromptMembers}> +> **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`](/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#prompt) + + + +TenantMembers}> +> **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`](/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#tenant) + + + +TransactionMembers}> +> **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`](/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#transaction) + + + +UserMembers}> +> **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`](/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#user) + + + +UntrustedDataMembers}> +> **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`](/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#untrusteddata) + + + +ScreenMembersOnPhoneIdentifierChallenge}> +> **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`](/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#screen) + +**Methods** + + + +> **submitPhoneChallenge**(`payload`): `Promise`\<`void`\> + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/phone-identifier-challenge.d.ts:33 + +**Parameters** + +**payload** + +[`PhoneChallengeOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PhoneChallengeOptions) + +**Returns** + +`Promise`\<`void`\> + + + + +> **resendCode**(`payload?`): `Promise`\<`void`\> + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/phone-identifier-challenge.d.ts:34 + +**Parameters** + +**payload?** + +[`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CustomOptions) + +**Returns** + +`Promise`\<`void`\> + + + + +> **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 + +**Parameters** + +**options?** + +[`StartResendOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/StartResendOptions) + +**Returns** + +[`ResendControl`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResendControl) + + + + +> **returnToPrevious**(`payload?`): `Promise`\<`void`\> + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/phone-identifier-challenge.d.ts:36 + +**Parameters** + +**payload?** + +[`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CustomOptions) + +**Returns** + +`Promise`\<`void`\> + + + + +> **switchToVoice**(`payload?`): `Promise`\<`void`\> + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/phone-identifier-challenge.d.ts:37 + +**Parameters** + +**payload?** + +[`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CustomOptions) + +**Returns** + +`Promise`\<`void`\> + + + + +> **switchToText**(`payload?`): `Promise`\<`void`\> + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/phone-identifier-challenge.d.ts:38 + +**Parameters** + +**payload?** + +[`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CustomOptions) + +**Returns** + +`Promise`\<`void`\> + 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..4e9e5c9c6 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PhoneIdentifierEnrollmentMembers.mdx @@ -0,0 +1,142 @@ +--- +title: "PhoneIdentifierEnrollmentMembers" +--- + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/phone-identifier-enrollment.d.ts:19 + +- Extends [`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers) + +## Properties + +BrandingMembers}> +> **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`](/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#branding) + + + +ClientMembers}> +> **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`](/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#client) + + + +OrganizationMembers}> +> **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`](/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#organization) + + + +PromptMembers}> +> **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`](/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#prompt) + + + +TenantMembers}> +> **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`](/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#tenant) + + + +TransactionMembers}> +> **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`](/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#transaction) + + + +UserMembers}> +> **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`](/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#user) + + + +UntrustedDataMembers}> +> **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`](/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#untrusteddata) + + + +ScreenMembersOnPhoneIdentifierEnrollment}> +> **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`](/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#screen) + +**Methods** + + + +> **continuePhoneEnrollment**(`payload`): `Promise`\<`void`\> + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/phone-identifier-enrollment.d.ts:21 + +**Parameters** + +**payload** + +[`PhoneEnrollmentOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PhoneEnrollmentOptions) + +**Returns** + +`Promise`\<`void`\> + + + + +> **returnToPrevious**(`payload?`): `Promise`\<`void`\> + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/phone-identifier-enrollment.d.ts:22 + +**Parameters** + +**payload?** + +[`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CustomOptions) + +**Returns** + +`Promise`\<`void`\> + 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 + + +> **country**: `string` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:46 + +The country name + + + + +> **country\_code**: `string` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:48 + +The country code (e.g. 'US', 'GB') + + + + +> **phone\_prefix**: `string` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:50 + +The phone prefix (e.g. '+1', '+44') + 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 + + +> **name**: `string` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/prompt.d.ts:5 + 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..ee968619b --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/RedeemTicketMembers.mdx @@ -0,0 +1,146 @@ +--- +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`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers) + +## Properties + +BrandingMembers}> +> **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`](/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#branding) + + + +TenantMembers}> +> **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`](/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#tenant) + + + +UserMembers}> +> **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`](/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#user) + + + +UntrustedDataMembers}> +> **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`](/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#untrusteddata) + + + +ClientMembers}> +> **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`](/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#client) + + + +OrganizationMembers}> +> **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`](/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#organization) + + + +PromptMembers}> +> **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`](/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#prompt) + + + +ScreenMembers}> +> **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`](/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#screen) + + + +TransactionMembers}> +> **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`](/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#transaction) + +**Methods** + + + +> **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`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/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(); +``` + 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..4b17b1443 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ReportBrowserErrorOptions.mdx @@ -0,0 +1,21 @@ +--- +title: "ReportBrowserErrorOptions" +--- + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/mfa-webauthn-platform-enrollment.d.ts:34 + +ReportBrowserErrorOptions + +## Properties + + + + + + + + + + + + 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..9c52669a0 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResendCodeOptionsPayload.mdx @@ -0,0 +1,16 @@ +--- +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`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/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/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..dcbbcb0f6 --- /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 + + +> **startResend**: () => `void` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/utils/resend-control.d.ts:19 + +**Returns** + +`void` + 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..49d213251 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResetPasswordEmailMembers.mdx @@ -0,0 +1,125 @@ +--- +title: "ResetPasswordEmailMembers" +--- + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/reset-password-email.d.ts:15 + +- Extends [`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers) + +## Properties + +BrandingMembers}> +> **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`](/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#branding) + + + +ClientMembers}> +> **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`](/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#client) + + + +OrganizationMembers}> +> **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`](/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#organization) + + + +PromptMembers}> +> **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`](/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#prompt) + + + +TenantMembers}> +> **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`](/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#tenant) + + + +TransactionMembers}> +> **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`](/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#transaction) + + + +UserMembers}> +> **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`](/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#user) + + + +UntrustedDataMembers}> +> **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`](/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#untrusteddata) + + + +ScreenMembersOnResetPasswordEmail}> +> **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`](/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#screen) + +**Methods** + + + +> **resendEmail**(`payload?`): `Promise`\<`void`\> + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/reset-password-email.d.ts:17 + +**Parameters** + +**payload?** + +[`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CustomOptions) + +**Returns** + +`Promise`\<`void`\> + 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..23faff84e --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResetPasswordErrorMembers.mdx @@ -0,0 +1,107 @@ +--- +title: "ResetPasswordErrorMembers" +--- + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/reset-password-error.d.ts:14 + +- Extends [`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers) + +## Properties + +BrandingMembers}> +> **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`](/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#branding) + + + +ClientMembers}> +> **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`](/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#client) + + + +OrganizationMembers}> +> **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`](/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#organization) + + + +PromptMembers}> +> **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`](/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#prompt) + + + +TenantMembers}> +> **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`](/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#tenant) + + + +TransactionMembers}> +> **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`](/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#transaction) + + + +UserMembers}> +> **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`](/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#user) + + + +UntrustedDataMembers}> +> **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`](/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#untrusteddata) + + + +ScreenMembersOnResetPasswordError}> +> **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`](/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#screen) + 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..e67c915cb --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResetPasswordMembers.mdx @@ -0,0 +1,142 @@ +--- +title: "ResetPasswordMembers" +--- + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/reset-password.d.ts:21 + +- Extends [`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers) + +## Properties + +BrandingMembers}> +> **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`](/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#branding) + + + +ClientMembers}> +> **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`](/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#client) + + + +OrganizationMembers}> +> **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`](/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#organization) + + + +PromptMembers}> +> **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`](/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#prompt) + + + +TenantMembers}> +> **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`](/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#tenant) + + + +UserMembers}> +> **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`](/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#user) + + + +UntrustedDataMembers}> +> **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`](/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#untrusteddata) + + + +ScreenMembersOnResetPassword}> +> **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`](/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#screen) + + + +TransactionMembersOnResetPassword}> +> **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`](/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#transaction) + +**Methods** + + + +> **resetPassword**(`payload`): `Promise`\<`void`\> + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/reset-password.d.ts:24 + +**Parameters** + +**payload** + +[`ResetPasswordOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResetPasswordOptions) + +**Returns** + +`Promise`\<`void`\> + + + + +> **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 + +**Parameters** + +**password** + +`string` + +**Returns** + +[`PasswordValidationResult`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PasswordValidationResult) + 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..ba4b67bc6 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResetPasswordMfaEmailChallengeMembers.mdx @@ -0,0 +1,194 @@ +--- +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`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers) + +## Properties + +BrandingMembers}> +> **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`](/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#branding) + + + +ClientMembers}> +> **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`](/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#client) + + + +OrganizationMembers}> +> **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`](/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#organization) + + + +PromptMembers}> +> **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`](/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#prompt) + + + +TenantMembers}> +> **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`](/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#tenant) + + + +TransactionMembers}> +> **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`](/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#transaction) + + + +UserMembers}> +> **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`](/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#user) + + + +UntrustedDataMembers}> +> **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`](/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#untrusteddata) + + + +ScreenMembersOnResetPasswordMfaEmailChallenge}> +> **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`](/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#screen) + +**Methods** + + + +> **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`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ContinueOptions) + +The options containing the code and rememberDevice flag. + +**Returns** + +`Promise`\<`void`\> + + + + +> **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`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResendCodeOptions) + +Optional custom options to include with the request. + +**Returns** + +`Promise`\<`void`\> + + + + +> **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`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TryAnotherMethodOptions) + +Optional custom options to include with the request. + +**Returns** + +`Promise`\<`void`\> + + + + +> **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 + +Gets resend functionality with timeout management for this screen + +**Parameters** + +**options?** + +[`StartResendOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/StartResendOptions) + +Configuration options for resend functionality + +**Returns** + +[`ResendControl`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResendControl) + 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 + + +> **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. + 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..6bb7a2a47 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResetPasswordMfaOtpChallengeMembers.mdx @@ -0,0 +1,152 @@ +--- +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`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers) + +## Properties + +BrandingMembers}> +> **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`](/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#branding) + + + +ClientMembers}> +> **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`](/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#client) + + + +OrganizationMembers}> +> **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`](/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#organization) + + + +PromptMembers}> +> **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`](/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#prompt) + + + +ScreenMembers}> +> **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`](/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#screen) + + + +TenantMembers}> +> **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`](/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#tenant) + + + +TransactionMembers}> +> **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`](/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#transaction) + + + +UserMembers}> +> **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`](/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#user) + + + +UntrustedDataMembers}> +> **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`](/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#untrusteddata) + +**Methods** + + + +> **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`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResetPasswordMfaOtpChallengeContinueOptions) + +The options containing the code. + +**Returns** + +`Promise`\<`void`\> + + + + +> **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`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResetPasswordMfaOtpChallengeTryAnotherMethodOptions) + +Optional custom options to include with the request. + +**Returns** + +`Promise`\<`void`\> + 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..2fc4dc069 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResetPasswordMfaPhoneChallengeContinueOptions.mdx @@ -0,0 +1,25 @@ +--- +title: "ResetPasswordMfaPhoneChallengeContinueOptions" +--- + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/reset-password-mfa-phone-challenge.d.ts:30 + +ContinueOptions + +- Extends [`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CustomOptions) + +## Indexable + +\[`key`: `string`\]: `string` \| `number` \| `boolean` \| `undefined` + +## Properties + + +> **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. + 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..e25c8eef4 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResetPasswordMfaPhoneChallengeMembers.mdx @@ -0,0 +1,205 @@ +--- +title: "ResetPasswordMfaPhoneChallengeMembers" +--- + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/reset-password-mfa-phone-challenge.d.ts:63 + +ResetPasswordMfaPhoneChallengeMembers + +- Extends [`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers) + +## Properties + +BrandingMembers}> +> **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`](/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#branding) + + + +TenantMembers}> +> **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`](/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#tenant) + + + +UserMembers}> +> **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`](/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#user) + + + +UntrustedDataMembers}> +> **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`](/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#untrusteddata) + + + +ClientMembers}> +> **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 + +Access to client-specific information (e.g., client ID, name). + +**Overrides** + +[`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#client) + + + +OrganizationMembers}> +> **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 + +Access to organization-specific information, if applicable. + +**Overrides** + +[`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#organization) + + + +PromptMembers}> +> **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 + +Access to prompt details (e.g., prompt name). + +**Overrides** + +[`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#prompt) + + + +ScreenMembersOnResetPasswordMfaPhoneChallenge}> +> **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 + +Access to the specific properties and data of the 'reset-password-mfa-phone-challenge' screen. + +**Overrides** + +[`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#screen) + + + +TransactionMembers}> +> **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 + +Access to the current transaction details (e.g., state, errors). + +**Overrides** + +[`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#transaction) + +**Methods** + + + +> **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`](/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. + +**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' }); +``` + + + + +> **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`](/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. + +**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' }); +``` + 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..acf6b78a6 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResetPasswordMfaPhoneChallengeTryAnotherMethodOptions.mdx @@ -0,0 +1,26 @@ +--- +title: "ResetPasswordMfaPhoneChallengeTryAnotherMethodOptions" +--- + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/reset-password-mfa-phone-challenge.d.ts:46 + +TryAnotherMethodOptions + +- Extends [`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CustomOptions) + +## Indexable + +\[`key`: `string`\]: `string` \| `number` \| `boolean` \| `undefined` + +## Properties + + +> **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. + 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..0ef5909f4 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResetPasswordMfaPushChallengePushMembers.mdx @@ -0,0 +1,215 @@ +--- +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`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers) + +## Properties + +BrandingMembers}> +> **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`](/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#branding) + + + +ClientMembers}> +> **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`](/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#client) + + + +OrganizationMembers}> +> **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`](/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#organization) + + + +PromptMembers}> +> **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`](/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#prompt) + + + +TenantMembers}> +> **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`](/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#tenant) + + + +TransactionMembers}> +> **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`](/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#transaction) + + + +UserMembers}> +> **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`](/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#user) + + + +UntrustedDataMembers}> +> **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`](/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#untrusteddata) + + + +ScreenMembersOnResetPasswordMfaPushChallengePush}> +> **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`](/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#screen) + +**Methods** + + + +> **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`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CustomOptions) + +Optional custom options to include with the request + +**Returns** + +`Promise`\<`void`\> + + + + +> **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`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CustomOptions) + +Optional custom options to include with the request + +**Returns** + +`Promise`\<`void`\> + + + + +> **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`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CustomOptions) + +Optional custom options to include with the request + +**Returns** + +`Promise`\<`void`\> + + + + +> **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`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CustomOptions) + +Optional custom options to include with the request + +**Returns** + +`Promise`\<`void`\> + + + + +> **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 + +Allows polling for the push notification challenge to be approved. + +**Parameters** + +**options?** + +[`MfaPollingOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/type-aliases/MfaPollingOptions) + +of type [MfaPollingOptions](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/type-aliases/MfaPollingOptions) + +**Returns** + +[`MfaPushPollingControl`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/MfaPushPollingControl) + 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..9eff1500e --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResetPasswordMfaRecoveryCodeChallengeMembers.mdx @@ -0,0 +1,158 @@ +--- +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`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers) + +## Properties + +BrandingMembers}> +> **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`](/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#branding) + + + +TenantMembers}> +> **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`](/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#tenant) + + + +UserMembers}> +> **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`](/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#user) + + + +UntrustedDataMembers}> +> **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`](/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#untrusteddata) + + + +ClientMembers}> +> **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`](/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#client) + + + +OrganizationMembers}> +> **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`](/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#organization) + + + +PromptMembers}> +> **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`](/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#prompt) + + + +ScreenMembers}> +> **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`](/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#screen) + + + +TransactionMembers}> +> **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`](/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#transaction) + +**Methods** + + + +> **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`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CustomOptions) + +Optional payload. + +**Returns** + +`Promise`\<`void`\> + + + + +> **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`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CustomOptions) + +Optional payload. + +**Returns** + +`Promise`\<`void`\> + 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..dea697465 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResetPasswordMfaSmsChallengeMembers.mdx @@ -0,0 +1,197 @@ +--- +title: "ResetPasswordMfaSmsChallengeMembers" +--- + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/reset-password-mfa-sms-challenge.d.ts:18 + +- Extends [`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers) + +## Properties + +BrandingMembers}> +> **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`](/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#branding) + + + +ClientMembers}> +> **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`](/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#client) + + + +OrganizationMembers}> +> **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`](/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#organization) + + + +PromptMembers}> +> **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`](/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#prompt) + + + +TenantMembers}> +> **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`](/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#tenant) + + + +TransactionMembers}> +> **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`](/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#transaction) + + + +UserMembers}> +> **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`](/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#user) + + + +UntrustedDataMembers}> +> **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`](/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#untrusteddata) + + + +ScreenMembersOnResetPasswordMfaSmsChallenge}> +> **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`](/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#screen) + +**Methods** + + + +> **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`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResetPasswordMfaSmsChallengeOptions) + +**Returns** + +`Promise`\<`void`\> + + + + +> **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`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CustomOptions) + +**Returns** + +`Promise`\<`void`\> + + + + +> **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`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CustomOptions) + +**Returns** + +`Promise`\<`void`\> + + + + +> **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`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CustomOptions) + +**Returns** + +`Promise`\<`void`\> + + + + +> **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 + +Gets resend functionality with timeout management for this screen + +**Parameters** + +**options?** + +[`StartResendOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/StartResendOptions) + +Configuration options for resend functionality + +**Returns** + +[`ResendControl`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResendControl) + 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 + + +> **code**: `string` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/reset-password-mfa-sms-challenge.d.ts:6 + 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..82b75fec2 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResetPasswordMfaVoiceChallengeContinueOptions.mdx @@ -0,0 +1,23 @@ +--- +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`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CustomOptions) + +## Indexable + +\[`key`: `string`\]: `string` \| `number` \| `boolean` \| `undefined` + +## Properties + + +> **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. + 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..a74cc9b7a --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResetPasswordMfaVoiceChallengeMembers.mdx @@ -0,0 +1,230 @@ +--- +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`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers) + +## Properties + +BrandingMembers}> +> **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`](/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#branding) + + + +ClientMembers}> +> **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`](/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#client) + + + +OrganizationMembers}> +> **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`](/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#organization) + + + +PromptMembers}> +> **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`](/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#prompt) + + + +TenantMembers}> +> **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`](/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#tenant) + + + +TransactionMembers}> +> **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`](/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#transaction) + + + +UserMembers}> +> **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`](/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#user) + + + +UntrustedDataMembers}> +> **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`](/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#untrusteddata) + + + +ScreenMembersOnResetPasswordMfaVoiceChallenge}> +> **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`](/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#screen) + +**Methods** + + + +> **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`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/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' }); +``` + + + + +> **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`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CustomOptions) + +Optional custom options to include with the request. + +**Returns** + +`Promise`\<`void`\> + +A promise that resolves when the action completes. + + + + +> **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`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CustomOptions) + +Optional custom options to include with the request. + +**Returns** + +`Promise`\<`void`\> + +A promise that resolves when the code is resent. + + + + +> **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`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CustomOptions) + +Optional custom options to include with the request. + +**Returns** + +`Promise`\<`void`\> + +A promise that resolves when the request is submitted. + + + + +> **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 + +Gets resend functionality with timeout management for this screen + +**Parameters** + +**options?** + +[`StartResendOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/StartResendOptions) + +Configuration options for resend functionality + +**Returns** + +[`ResendControl`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResendControl) + 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..fe8218f40 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResetPasswordMfaWebAuthnPlatformChallengeContinueOptions.mdx @@ -0,0 +1,25 @@ +--- +title: "ResetPasswordMfaWebAuthnPlatformChallengeContinueOptions" +--- + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/reset-password-mfa-webauthn-platform-challenge.d.ts:54 + +ContinueWithPasskeyOptions + +- Extends [`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CustomOptions) + +## Indexable + +\[`key`: `string`\]: `string` \| `number` \| `boolean` \| `undefined` + +## Properties + + +> `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. + 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..d7135c18a --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResetPasswordMfaWebAuthnPlatformChallengeMembers.mdx @@ -0,0 +1,251 @@ +--- +title: "ResetPasswordMfaWebAuthnPlatformChallengeMembers" +--- + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/reset-password-mfa-webauthn-platform-challenge.d.ts:106 + +ResetPasswordMfaWebAuthnPlatformChallengeMembers + +- Extends [`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers) + +## Properties + +BrandingMembers}> +> **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`](/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#branding) + + + +ClientMembers}> +> **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`](/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#client) + + + +OrganizationMembers}> +> **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`](/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#organization) + + + +PromptMembers}> +> **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`](/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#prompt) + + + +TenantMembers}> +> **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`](/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#tenant) + + + +TransactionMembers}> +> **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`](/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#transaction) + + + +UserMembers}> +> **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`](/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#user) + + + +UntrustedDataMembers}> +> **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`](/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#untrusteddata) + + + +ScreenMembersOnResetPasswordMfaWebAuthnPlatformChallenge}> +> **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 + +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/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`screen`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers#screen) + +**Methods** + + + +> **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`](/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. + +**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. +} +``` + + + + +> **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`](/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. + +**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); +} +``` + + + + +> **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`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/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); +} +``` + 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..ce2da63c1 --- /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 + +WebAuthnErrorDetails}> +> **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 + +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/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..659365bb9 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResetPasswordMfaWebAuthnPlatformChallengeTryAnotherMethodOptions.mdx @@ -0,0 +1,13 @@ +--- +title: "ResetPasswordMfaWebAuthnPlatformChallengeTryAnotherMethodOptions" +--- + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/reset-password-mfa-webauthn-platform-challenge.d.ts:88 + +TryAnotherMethodOptions + +- Extends [`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/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/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..f77ffd066 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResetPasswordMfaWebAuthnRoamingChallengeMembers.mdx @@ -0,0 +1,212 @@ +--- +title: "ResetPasswordMfaWebAuthnRoamingChallengeMembers" +--- + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/reset-password-mfa-webauthn-roaming-challenge.d.ts:137 + +ResetPasswordMfaWebAuthnRoamingChallengeMembers + +- Extends [`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers) + +## Properties + +BrandingMembers}> +> **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`](/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#branding) + + + +ClientMembers}> +> **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`](/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#client) + + + +OrganizationMembers}> +> **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`](/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#organization) + + + +PromptMembers}> +> **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`](/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#prompt) + + + +TenantMembers}> +> **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`](/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#tenant) + + + +TransactionMembers}> +> **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`](/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#transaction) + + + +UserMembers}> +> **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`](/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#user) + + + +UntrustedDataMembers}> +> **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`](/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#untrusteddata) + + + +ScreenMembersOnResetPasswordMfaWebAuthnRoamingChallenge}> +> **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 + +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/react-sdk/API-Reference/Types/interfaces/BaseMembers).[`screen`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers#screen) + +**Methods** + + + +> **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`](/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. +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. + + + + +> **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`](/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. + +**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). + + + + +> **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`](/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. + +**Returns** + +`Promise`\<`void`\> + +A promise that resolves when the 'pick-authenticator' action is submitted. + +**Throws** + +Throws an error if the form submission fails. + 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..60acfa2b2 --- /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 + +WebAuthnErrorDetails}> +> **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 + +The error object from the WebAuthn API (`navigator.credentials.get()`) +containing `name` and `message` of the DOMException. + + + + +> `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. + 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..e444e88a8 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResetPasswordMfaWebAuthnRoamingChallengeTryAnotherMethodOptions.mdx @@ -0,0 +1,24 @@ +--- +title: "ResetPasswordMfaWebAuthnRoamingChallengeTryAnotherMethodOptions" +--- + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/reset-password-mfa-webauthn-roaming-challenge.d.ts:116 + +TryAnotherMethodOptions + +- Extends [`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CustomOptions) + +## Indexable + +\[`key`: `string`\]: `string` \| `number` \| `boolean` \| `undefined` + +## Properties + + +> `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. + 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..8a07edff1 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResetPasswordMfaWebAuthnRoamingChallengeUseSecurityKeyOptions.mdx @@ -0,0 +1,25 @@ +--- +title: "ResetPasswordMfaWebAuthnRoamingChallengeUseSecurityKeyOptions" +--- + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/reset-password-mfa-webauthn-roaming-challenge.d.ts:70 + +UseSecurityKeyOptions + +- Extends [`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CustomOptions) + +## Indexable + +\[`key`: `string`\]: `string` \| `number` \| `boolean` \| `undefined` + +## Properties + + +> `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. + 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 + + +> **password-reset**: `string` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/reset-password.d.ts:6 + + + + +> **re-enter-password**: `string` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/reset-password.d.ts:7 + 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..04b44dc83 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResetPasswordRequestMembers.mdx @@ -0,0 +1,153 @@ +--- +title: "ResetPasswordRequestMembers" +--- + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/reset-password-request.d.ts:23 + +- Extends [`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers) + +## Properties + +BrandingMembers}> +> **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`](/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#branding) + + + +ClientMembers}> +> **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`](/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#client) + + + +OrganizationMembers}> +> **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`](/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#organization) + + + +PromptMembers}> +> **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`](/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#prompt) + + + +TenantMembers}> +> **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`](/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#tenant) + + + +UserMembers}> +> **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`](/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#user) + + + +UntrustedDataMembers}> +> **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`](/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#untrusteddata) + + + +ScreenMembersOnResetPasswordRequest}> +> **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`](/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#screen) + + + +TransactionMembersOnResetPasswordRequest}> +> **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`](/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#transaction) + +**Methods** + + + +> **resetPassword**(`payload`): `Promise`\<`void`\> + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/reset-password-request.d.ts:26 + +**Parameters** + +**payload** + +[`ResetPasswordRequestOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResetPasswordRequestOptions) + +**Returns** + +`Promise`\<`void`\> + + + + +> **backToLogin**(`payload?`): `Promise`\<`void`\> + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/reset-password-request.d.ts:27 + +**Parameters** + +**payload?** + +[`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CustomOptions) + +**Returns** + +`Promise`\<`void`\> + + + + +> **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`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/type-aliases/IdentifierType)[] \| `null` + 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 + + +> **username**: `string` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/reset-password-request.d.ts:7 + + + + +> `optional` **captcha**: `string` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/reset-password-request.d.ts:8 + 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..0a644c9e6 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ResetPasswordSuccessMembers.mdx @@ -0,0 +1,107 @@ +--- +title: "ResetPasswordSuccessMembers" +--- + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/reset-password-success.d.ts:11 + +- Extends [`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers) + +## Properties + +BrandingMembers}> +> **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`](/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#branding) + + + +ClientMembers}> +> **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`](/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#client) + + + +OrganizationMembers}> +> **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`](/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#organization) + + + +PromptMembers}> +> **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`](/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#prompt) + + + +TenantMembers}> +> **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`](/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#tenant) + + + +TransactionMembers}> +> **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`](/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#transaction) + + + +UserMembers}> +> **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`](/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#user) + + + +UntrustedDataMembers}> +> **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`](/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#untrusteddata) + + + +ScreenMembersOnResetPasswordSuccess}> +> **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`](/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#screen) + 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 + + +> **value**: `string` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:53 + + + + +> `optional` **description**: `string` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.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 new file mode 100644 index 000000000..997f80175 --- /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`](/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 + + +> **name**: `string` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:71 + + + + +> **captchaImage**: `string` \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:72 + + + + +> **captchaSiteKey**: `string` \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:73 + + + + +> **captchaProvider**: `string` \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:74 + + + + +> **isCaptchaAvailable**: `boolean` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:75 + + + +Record<string, string | boolean | string[] | Record<string, string[]> | PhonePrefix[] | PasskeyCreate>}> +> **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 + + + + +> **links**: `Record`\<`string`, `string`\> \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:77 + + + + +> **texts**: `Record`\<`string`, `string`\> \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:78 + + + +CaptchaContext}> +> **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 new file mode 100644 index 000000000..7ed22d21f --- /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`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers) + +## Properties + + +> **name**: `string` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:71 + +**Inherited from** + +[`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#name) + + + + +> **captchaImage**: `string` \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:72 + +**Inherited from** + +[`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#captchaimage) + + + + +> **captchaSiteKey**: `string` \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:73 + +**Inherited from** + +[`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#captchasitekey) + + + + +> **captchaProvider**: `string` \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:74 + +**Inherited from** + +[`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#captchaprovider) + + + + +> **isCaptchaAvailable**: `boolean` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:75 + +**Inherited from** + +[`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#iscaptchaavailable) + + + + +> **links**: `Record`\<`string`, `string`\> \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:77 + +**Inherited from** + +[`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#links) + + + + +> **texts**: `Record`\<`string`, `string`\> \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:78 + +**Inherited from** + +[`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#texts) + + + +CaptchaContext}> +> **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`](/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#captcha) + + + + + + + + + + + + + + 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..8b3560665 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnConsent.mdx @@ -0,0 +1,125 @@ +--- +title: "ScreenMembersOnConsent" +--- + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/consent.d.ts:19 + +ScreenMembersOnConsent + +- Extends [`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers) + +## Properties + + +> **name**: `string` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:71 + +**Inherited from** + +[`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#name) + + + + +> **captchaImage**: `string` \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:72 + +**Inherited from** + +[`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#captchaimage) + + + + +> **captchaSiteKey**: `string` \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:73 + +**Inherited from** + +[`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#captchasitekey) + + + + +> **captchaProvider**: `string` \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:74 + +**Inherited from** + +[`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#captchaprovider) + + + + +> **isCaptchaAvailable**: `boolean` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:75 + +**Inherited from** + +[`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#iscaptchaavailable) + + + +Record<string, string | boolean | string[] | Record<string, string[]> | PhonePrefix[] | PasskeyCreate>}> +> **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 + +Screen-specific data. + +**Inherited from** + +[`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#data) + + + + +> **links**: `Record`\<`string`, `string`\> \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:77 + +**Inherited from** + +[`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#links) + + + + +> **texts**: `Record`\<`string`, `string`\> \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:78 + +**Inherited from** + +[`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#texts) + + + +CaptchaContext}> +> **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`](/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#captcha) + + + +Scope[]}> +> **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 + + + + +> **hideScopes**: `boolean` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/consent.d.ts:21 + 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..690ab7032 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnCustomizedConsent.mdx @@ -0,0 +1,135 @@ +--- +title: "ScreenMembersOnCustomizedConsent" +--- + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/customized-consent.d.ts:18 + +ScreenMembersOnCustomizedConsent + +- Extends [`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers) + +## Properties + + +> **name**: `string` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:71 + +**Inherited from** + +[`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#name) + + + + +> **captchaImage**: `string` \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:72 + +**Inherited from** + +[`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#captchaimage) + + + + +> **captchaSiteKey**: `string` \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:73 + +**Inherited from** + +[`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#captchasitekey) + + + + +> **captchaProvider**: `string` \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:74 + +**Inherited from** + +[`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#captchaprovider) + + + + +> **isCaptchaAvailable**: `boolean` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:75 + +**Inherited from** + +[`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#iscaptchaavailable) + + + +Record<string, string | boolean | string[] | Record<string, string[]> | PhonePrefix[] | PasskeyCreate>}> +> **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 + +Screen-specific data. + +**Inherited from** + +[`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#data) + + + + +> **links**: `Record`\<`string`, `string`\> \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:77 + +**Inherited from** + +[`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#links) + + + + +> **texts**: `Record`\<`string`, `string`\> \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:78 + +**Inherited from** + +[`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#texts) + + + +CaptchaContext}> +> **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`](/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#captcha) + + + +Scope[]}> +> **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 + +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. + + + +AuthorizationDetail[]}> +> **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 + +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. + 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..c15e898af --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnDeviceCodeConfirmation.mdx @@ -0,0 +1,108 @@ +--- +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`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers) + +## Properties + + +> **name**: `string` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:71 + +**Inherited from** + +[`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#name) + + + + +> **captchaImage**: `string` \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:72 + +**Inherited from** + +[`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#captchaimage) + + + + +> **captchaSiteKey**: `string` \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:73 + +**Inherited from** + +[`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#captchasitekey) + + + + +> **captchaProvider**: `string` \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:74 + +**Inherited from** + +[`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#captchaprovider) + + + + +> **isCaptchaAvailable**: `boolean` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:75 + +**Inherited from** + +[`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#iscaptchaavailable) + + + + +> **links**: `Record`\<`string`, `string`\> \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:77 + +**Inherited from** + +[`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#links) + + + + +> **texts**: `Record`\<`string`, `string`\> \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:78 + +**Inherited from** + +[`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#texts) + + + +CaptchaContext}> +> **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`](/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#captcha) + + + + + + + + + + + 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..bafdcc648 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnEmailIdentifierChallenge.mdx @@ -0,0 +1,112 @@ +--- +title: "ScreenMembersOnEmailIdentifierChallenge" +--- + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/email-identifier-challenge.d.ts:10 + +- Extends [`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers) + +## Properties + + +> **name**: `string` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:71 + +**Inherited from** + +[`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#name) + + + + +> **captchaImage**: `string` \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:72 + +**Inherited from** + +[`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#captchaimage) + + + + +> **captchaSiteKey**: `string` \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:73 + +**Inherited from** + +[`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#captchasitekey) + + + + +> **captchaProvider**: `string` \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:74 + +**Inherited from** + +[`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#captchaprovider) + + + + +> **isCaptchaAvailable**: `boolean` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:75 + +**Inherited from** + +[`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#iscaptchaavailable) + + + + +> **links**: `Record`\<`string`, `string`\> \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:77 + +**Inherited from** + +[`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#links) + + + + +> **texts**: `Record`\<`string`, `string`\> \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:78 + +**Inherited from** + +[`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#texts) + + + +CaptchaContext}> +> **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`](/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#captcha) + + + + + + + + + + + + + + + + + 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..0a707424a --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnEmailOTPChallenge.mdx @@ -0,0 +1,110 @@ +--- +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`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers) + +## Properties + + +> **name**: `string` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:71 + +**Inherited from** + +[`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#name) + + + + +> **captchaImage**: `string` \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:72 + +**Inherited from** + +[`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#captchaimage) + + + + +> **captchaSiteKey**: `string` \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:73 + +**Inherited from** + +[`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#captchasitekey) + + + + +> **captchaProvider**: `string` \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:74 + +**Inherited from** + +[`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#captchaprovider) + + + + +> **isCaptchaAvailable**: `boolean` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:75 + +**Inherited from** + +[`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#iscaptchaavailable) + + + +Record<string, string | boolean | string[] | Record<string, string[]> | PhonePrefix[] | PasskeyCreate>}> +> **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`](/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#data) + + + + +> **links**: `Record`\<`string`, `string`\> \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:77 + +**Inherited from** + +[`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#links) + + + + +> **texts**: `Record`\<`string`, `string`\> \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:78 + +**Inherited from** + +[`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#texts) + + + +CaptchaContext}> +> **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`](/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#captcha) + 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..7a31c8305 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnEmailVerificationResult.mdx @@ -0,0 +1,118 @@ +--- +title: "ScreenMembersOnEmailVerificationResult" +--- + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/email-verification-result.d.ts:15 + +ScreenMembersOnEmailVerificationResult + +- Extends [`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers) + +## Properties + + +> **name**: `string` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:71 + +**Inherited from** + +[`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#name) + + + + +> **captchaImage**: `string` \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:72 + +**Inherited from** + +[`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#captchaimage) + + + + +> **captchaSiteKey**: `string` \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:73 + +**Inherited from** + +[`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#captchasitekey) + + + + +> **captchaProvider**: `string` \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:74 + +**Inherited from** + +[`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#captchaprovider) + + + + +> **isCaptchaAvailable**: `boolean` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:75 + +**Inherited from** + +[`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#iscaptchaavailable) + + + + +> **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`](/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#links) + + + + +> **texts**: `Record`\<`string`, `string`\> \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:78 + +**Inherited from** + +[`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#texts) + + + +CaptchaContext}> +> **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`](/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#captcha) + + + + + + + + + + + + + +> **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. + 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..347bca310 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnLogin.mdx @@ -0,0 +1,122 @@ +--- +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`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers) + +## Properties + + +> **name**: `string` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:71 + +**Inherited from** + +[`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#name) + + + + +> **captchaImage**: `string` \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:72 + +**Inherited from** + +[`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#captchaimage) + + + + +> **captchaSiteKey**: `string` \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:73 + +**Inherited from** + +[`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#captchasitekey) + + + + +> **captchaProvider**: `string` \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:74 + +**Inherited from** + +[`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#captchaprovider) + + + + +> **isCaptchaAvailable**: `boolean` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:75 + +**Inherited from** + +[`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#iscaptchaavailable) + + + + +> **links**: `Record`\<`string`, `string`\> \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:77 + +**Inherited from** + +[`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#links) + + + + +> **texts**: `Record`\<`string`, `string`\> \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:78 + +**Inherited from** + +[`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#texts) + + + +CaptchaContext}> +> **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`](/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#captcha) + + + + +> **signupLink**: `string` \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/login.d.ts:19 + + + + +> **resetPasswordLink**: `string` \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/login.d.ts:20 + + + + + + + + + + + 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..339b23665 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnLoginId.mdx @@ -0,0 +1,134 @@ +--- +title: "ScreenMembersOnLoginId" +--- + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/login-id.d.ts:26 + +- Extends [`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers) + +## Properties + + +> **name**: `string` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:71 + +**Inherited from** + +[`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#name) + + + + +> **captchaImage**: `string` \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:72 + +**Inherited from** + +[`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#captchaimage) + + + + +> **captchaSiteKey**: `string` \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:73 + +**Inherited from** + +[`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#captchasitekey) + + + + +> **captchaProvider**: `string` \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:74 + +**Inherited from** + +[`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#captchaprovider) + + + + +> **isCaptchaAvailable**: `boolean` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:75 + +**Inherited from** + +[`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#iscaptchaavailable) + + + +Record<string, string | boolean | string[] | Record<string, string[]> | PhonePrefix[] | PasskeyCreate>}> +> **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`](/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#data) + + + + +> **links**: `Record`\<`string`, `string`\> \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:77 + +**Inherited from** + +[`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#links) + + + + +> **texts**: `Record`\<`string`, `string`\> \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:78 + +**Inherited from** + +[`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#texts) + + + +CaptchaContext}> +> **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`](/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#captcha) + + + + +> **signupLink**: `string` \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/login-id.d.ts:27 + + + + +> **resetPasswordLink**: `string` \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/login-id.d.ts:28 + + + + + + + + + + AllowCredential[]}> + + + + 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..87c96c59c --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnLoginPassword.mdx @@ -0,0 +1,127 @@ +--- +title: "ScreenMembersOnLoginPassword" +--- + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/login-password.d.ts:12 + +- Extends [`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers) + +## Properties + + +> **name**: `string` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:71 + +**Inherited from** + +[`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#name) + + + + +> **captchaImage**: `string` \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:72 + +**Inherited from** + +[`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#captchaimage) + + + + +> **captchaSiteKey**: `string` \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:73 + +**Inherited from** + +[`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#captchasitekey) + + + + +> **captchaProvider**: `string` \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:74 + +**Inherited from** + +[`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#captchaprovider) + + + + +> **isCaptchaAvailable**: `boolean` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:75 + +**Inherited from** + +[`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#iscaptchaavailable) + + + + +> **links**: `Record`\<`string`, `string`\> \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:77 + +**Inherited from** + +[`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#links) + + + + +> **texts**: `Record`\<`string`, `string`\> \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:78 + +**Inherited from** + +[`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#texts) + + + +CaptchaContext}> +> **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`](/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#captcha) + + + + +> **signupLink**: `string` \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/login-password.d.ts:13 + + + + +> **resetPasswordLink**: `string` \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/login-password.d.ts:14 + + + + +> **editIdentifierLink**: `string` \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/login-password.d.ts:15 + + + + + + + + + + + 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..721e0949d --- /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`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers) + +## Properties + + +> **name**: `string` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:71 + +**Inherited from** + +[`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#name) + + + + +> **captchaImage**: `string` \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:72 + +**Inherited from** + +[`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#captchaimage) + + + + +> **captchaSiteKey**: `string` \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:73 + +**Inherited from** + +[`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#captchasitekey) + + + + +> **captchaProvider**: `string` \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:74 + +**Inherited from** + +[`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#captchaprovider) + + + + +> **isCaptchaAvailable**: `boolean` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:75 + +**Inherited from** + +[`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#iscaptchaavailable) + + + + +> **links**: `Record`\<`string`, `string`\> \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:77 + +**Inherited from** + +[`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#links) + + + + +> **texts**: `Record`\<`string`, `string`\> \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:78 + +**Inherited from** + +[`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#texts) + + + +CaptchaContext}> +> **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`](/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#captcha) + + + + +> **editIdentifierLink**: `string` \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/login-passwordless-email-code.d.ts:7 + + + + +> **resetPasswordLink**: `string` \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/login-passwordless-email-code.d.ts:8 + + + + +> **signupLink**: `string` \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/login-passwordless-email-code.d.ts:9 + + + + + + + + + + + + + + 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..1c7bc261f --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnLoginPasswordlessSmsOtp.mdx @@ -0,0 +1,130 @@ +--- +title: "ScreenMembersOnLoginPasswordlessSmsOtp" +--- + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/login-passwordless-sms-otp.d.ts:13 + +- Extends [`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers) + +## Properties + + +> **name**: `string` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:71 + +**Inherited from** + +[`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#name) + + + + +> **captchaImage**: `string` \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:72 + +**Inherited from** + +[`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#captchaimage) + + + + +> **captchaSiteKey**: `string` \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:73 + +**Inherited from** + +[`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#captchasitekey) + + + + +> **captchaProvider**: `string` \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:74 + +**Inherited from** + +[`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#captchaprovider) + + + + +> **isCaptchaAvailable**: `boolean` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:75 + +**Inherited from** + +[`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#iscaptchaavailable) + + + + +> **links**: `Record`\<`string`, `string`\> \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:77 + +**Inherited from** + +[`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#links) + + + + +> **texts**: `Record`\<`string`, `string`\> \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:78 + +**Inherited from** + +[`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#texts) + + + +CaptchaContext}> +> **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`](/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#captcha) + + + + +> **signupLink**: `string` \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/login-passwordless-sms-otp.d.ts:14 + + + + +> **resetPasswordLink**: `string` \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/login-passwordless-sms-otp.d.ts:15 + + + + +> **backLink**: `string` \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/login-passwordless-sms-otp.d.ts:16 + + + + + + + + + + + + + + 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..f237fb334 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaCountryCodes.mdx @@ -0,0 +1,108 @@ +--- +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`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers) + +## Properties + + +> **name**: `string` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:71 + +**Inherited from** + +[`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#name) + + + + +> **captchaImage**: `string` \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:72 + +**Inherited from** + +[`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#captchaimage) + + + + +> **captchaSiteKey**: `string` \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:73 + +**Inherited from** + +[`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#captchasitekey) + + + + +> **captchaProvider**: `string` \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:74 + +**Inherited from** + +[`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#captchaprovider) + + + + +> **isCaptchaAvailable**: `boolean` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:75 + +**Inherited from** + +[`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#iscaptchaavailable) + + + + +> **links**: `Record`\<`string`, `string`\> \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:77 + +**Inherited from** + +[`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#links) + + + + +> **texts**: `Record`\<`string`, `string`\> \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:78 + +**Inherited from** + +[`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#texts) + + + +CaptchaContext}> +> **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`](/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#captcha) + + + + + + + PhonePrefix[]}> + + + + 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..630bdfda7 --- /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`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers) + +## Properties + + +> **name**: `string` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:71 + +**Inherited from** + +[`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#name) + + + + +> **captchaImage**: `string` \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:72 + +**Inherited from** + +[`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#captchaimage) + + + + +> **captchaSiteKey**: `string` \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:73 + +**Inherited from** + +[`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#captchasitekey) + + + + +> **captchaProvider**: `string` \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:74 + +**Inherited from** + +[`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#captchaprovider) + + + + +> **isCaptchaAvailable**: `boolean` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:75 + +**Inherited from** + +[`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#iscaptchaavailable) + + + + +> **links**: `Record`\<`string`, `string`\> \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:77 + +**Inherited from** + +[`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#links) + + + + +> **texts**: `Record`\<`string`, `string`\> \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:78 + +**Inherited from** + +[`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#texts) + + + +CaptchaContext}> +> **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`](/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#captcha) + + + + + + + + + + + + + + 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..783e72ae2 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaEmailList.mdx @@ -0,0 +1,108 @@ +--- +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`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers) + +## Properties + + +> **name**: `string` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:71 + +**Inherited from** + +[`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#name) + + + + +> **captchaImage**: `string` \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:72 + +**Inherited from** + +[`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#captchaimage) + + + + +> **captchaSiteKey**: `string` \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:73 + +**Inherited from** + +[`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#captchasitekey) + + + + +> **captchaProvider**: `string` \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:74 + +**Inherited from** + +[`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#captchaprovider) + + + + +> **isCaptchaAvailable**: `boolean` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:75 + +**Inherited from** + +[`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#iscaptchaavailable) + + + + +> **links**: `Record`\<`string`, `string`\> \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:77 + +**Inherited from** + +[`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#links) + + + + +> **texts**: `Record`\<`string`, `string`\> \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:78 + +**Inherited from** + +[`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#texts) + + + +CaptchaContext}> +> **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`](/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#captcha) + + + + + + + + + + + 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..b3069c356 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaEnrollResult.mdx @@ -0,0 +1,108 @@ +--- +title: "ScreenMembersOnMfaEnrollResult" +--- + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/mfa-enroll-result.d.ts:12 + +ScreenMembersOnMfaEnrollResult + +- Extends [`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers) + +## Properties + + +> **name**: `string` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:71 + +**Inherited from** + +[`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#name) + + + + +> **captchaImage**: `string` \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:72 + +**Inherited from** + +[`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#captchaimage) + + + + +> **captchaSiteKey**: `string` \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:73 + +**Inherited from** + +[`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#captchasitekey) + + + + +> **captchaProvider**: `string` \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:74 + +**Inherited from** + +[`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#captchaprovider) + + + + +> **isCaptchaAvailable**: `boolean` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:75 + +**Inherited from** + +[`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#iscaptchaavailable) + + + + +> **links**: `Record`\<`string`, `string`\> \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:77 + +**Inherited from** + +[`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#links) + + + + +> **texts**: `Record`\<`string`, `string`\> \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:78 + +**Inherited from** + +[`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#texts) + + + +CaptchaContext}> +> **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`](/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#captcha) + + + + + + + + + + + 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..251f4bafe --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaLoginOptions.mdx @@ -0,0 +1,108 @@ +--- +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`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers) + +## Properties + + +> **name**: `string` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:71 + +**Inherited from** + +[`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#name) + + + + +> **captchaImage**: `string` \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:72 + +**Inherited from** + +[`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#captchaimage) + + + + +> **captchaSiteKey**: `string` \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:73 + +**Inherited from** + +[`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#captchasitekey) + + + + +> **captchaProvider**: `string` \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:74 + +**Inherited from** + +[`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#captchaprovider) + + + + +> **isCaptchaAvailable**: `boolean` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:75 + +**Inherited from** + +[`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#iscaptchaavailable) + + + + +> **links**: `Record`\<`string`, `string`\> \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:77 + +**Inherited from** + +[`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#links) + + + + +> **texts**: `Record`\<`string`, `string`\> \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:78 + +**Inherited from** + +[`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#texts) + + + +CaptchaContext}> +> **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`](/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#captcha) + + + + + + + + + + + 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..7b4cc7ffc --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaOtpChallenge.mdx @@ -0,0 +1,108 @@ +--- +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`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers) + +## Properties + + +> **name**: `string` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:71 + +**Inherited from** + +[`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#name) + + + + +> **captchaImage**: `string` \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:72 + +**Inherited from** + +[`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#captchaimage) + + + + +> **captchaSiteKey**: `string` \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:73 + +**Inherited from** + +[`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#captchasitekey) + + + + +> **captchaProvider**: `string` \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:74 + +**Inherited from** + +[`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#captchaprovider) + + + + +> **isCaptchaAvailable**: `boolean` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:75 + +**Inherited from** + +[`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#iscaptchaavailable) + + + + +> **links**: `Record`\<`string`, `string`\> \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:77 + +**Inherited from** + +[`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#links) + + + + +> **texts**: `Record`\<`string`, `string`\> \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:78 + +**Inherited from** + +[`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#texts) + + + +CaptchaContext}> +> **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`](/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#captcha) + + + + + + + + + + + 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..19bc74157 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaOtpEnrollmentCode.mdx @@ -0,0 +1,108 @@ +--- +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`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers) + +## Properties + + +> **name**: `string` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:71 + +**Inherited from** + +[`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#name) + + + + +> **captchaImage**: `string` \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:72 + +**Inherited from** + +[`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#captchaimage) + + + + +> **captchaSiteKey**: `string` \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:73 + +**Inherited from** + +[`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#captchasitekey) + + + + +> **captchaProvider**: `string` \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:74 + +**Inherited from** + +[`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#captchaprovider) + + + + +> **isCaptchaAvailable**: `boolean` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:75 + +**Inherited from** + +[`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#iscaptchaavailable) + + + + +> **links**: `Record`\<`string`, `string`\> \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:77 + +**Inherited from** + +[`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#links) + + + + +> **texts**: `Record`\<`string`, `string`\> \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:78 + +**Inherited from** + +[`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#texts) + + + +CaptchaContext}> +> **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`](/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#captcha) + + + + + + + + + + + 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..420b6b2a0 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaOtpEnrollmentQr.mdx @@ -0,0 +1,108 @@ +--- +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`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers) + +## Properties + + +> **name**: `string` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:71 + +**Inherited from** + +[`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#name) + + + + +> **captchaImage**: `string` \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:72 + +**Inherited from** + +[`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#captchaimage) + + + + +> **captchaSiteKey**: `string` \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:73 + +**Inherited from** + +[`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#captchasitekey) + + + + +> **captchaProvider**: `string` \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:74 + +**Inherited from** + +[`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#captchaprovider) + + + + +> **isCaptchaAvailable**: `boolean` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:75 + +**Inherited from** + +[`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#iscaptchaavailable) + + + + +> **links**: `Record`\<`string`, `string`\> \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:77 + +**Inherited from** + +[`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#links) + + + + +> **texts**: `Record`\<`string`, `string`\> \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:78 + +**Inherited from** + +[`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#texts) + + + +CaptchaContext}> +> **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`](/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#captcha) + + + + + + + + + + + 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..1578a7cdb --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaPhoneChallenge.mdx @@ -0,0 +1,108 @@ +--- +title: "ScreenMembersOnMfaPhoneChallenge" +--- + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/mfa-phone-challenge.d.ts:14 + +ScreenMembersOnMfaPhoneChallenge + +- Extends [`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers) + +## Properties + + +> **name**: `string` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:71 + +**Inherited from** + +[`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#name) + + + + +> **captchaImage**: `string` \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:72 + +**Inherited from** + +[`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#captchaimage) + + + + +> **captchaSiteKey**: `string` \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:73 + +**Inherited from** + +[`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#captchasitekey) + + + + +> **captchaProvider**: `string` \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:74 + +**Inherited from** + +[`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#captchaprovider) + + + + +> **isCaptchaAvailable**: `boolean` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:75 + +**Inherited from** + +[`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#iscaptchaavailable) + + + + +> **links**: `Record`\<`string`, `string`\> \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:77 + +**Inherited from** + +[`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#links) + + + + +> **texts**: `Record`\<`string`, `string`\> \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:78 + +**Inherited from** + +[`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#texts) + + + +CaptchaContext}> +> **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`](/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#captcha) + + + + + + + + + + + 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..26ef2db4b --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaPushChallengePush.mdx @@ -0,0 +1,111 @@ +--- +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`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers) + +## Properties + + +> **name**: `string` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:71 + +**Inherited from** + +[`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#name) + + + + +> **captchaImage**: `string` \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:72 + +**Inherited from** + +[`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#captchaimage) + + + + +> **captchaSiteKey**: `string` \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:73 + +**Inherited from** + +[`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#captchasitekey) + + + + +> **captchaProvider**: `string` \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:74 + +**Inherited from** + +[`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#captchaprovider) + + + + +> **isCaptchaAvailable**: `boolean` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:75 + +**Inherited from** + +[`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#iscaptchaavailable) + + + + +> **links**: `Record`\<`string`, `string`\> \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:77 + +**Inherited from** + +[`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#links) + + + + +> **texts**: `Record`\<`string`, `string`\> \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:78 + +**Inherited from** + +[`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#texts) + + + +CaptchaContext}> +> **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`](/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#captcha) + + + + + + + + + + + + + + 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..5a09049b9 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaPushEnrollmentQr.mdx @@ -0,0 +1,114 @@ +--- +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`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers) + +## Properties + + +> **name**: `string` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:71 + +**Inherited from** + +[`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#name) + + + + +> **captchaImage**: `string` \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:72 + +**Inherited from** + +[`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#captchaimage) + + + + +> **captchaSiteKey**: `string` \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:73 + +**Inherited from** + +[`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#captchasitekey) + + + + +> **captchaProvider**: `string` \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:74 + +**Inherited from** + +[`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#captchaprovider) + + + + +> **isCaptchaAvailable**: `boolean` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:75 + +**Inherited from** + +[`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#iscaptchaavailable) + + + + +> **links**: `Record`\<`string`, `string`\> \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:77 + +**Inherited from** + +[`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#links) + + + + +> **texts**: `Record`\<`string`, `string`\> \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:78 + +**Inherited from** + +[`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#texts) + + + +CaptchaContext}> +> **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`](/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#captcha) + + + + + + + + + + + + + + + + + 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..c4d90b780 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaPushWelcome.mdx @@ -0,0 +1,126 @@ +--- +title: "ScreenMembersOnMfaPushWelcome" +--- + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/mfa-push-welcome.d.ts:7 + +- Extends [`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers) + +## Properties + + +> **name**: `string` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:71 + +**Inherited from** + +[`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#name) + + + + +> **captchaImage**: `string` \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:72 + +**Inherited from** + +[`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#captchaimage) + + + + +> **captchaSiteKey**: `string` \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:73 + +**Inherited from** + +[`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#captchasitekey) + + + + +> **captchaProvider**: `string` \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:74 + +**Inherited from** + +[`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#captchaprovider) + + + + +> **isCaptchaAvailable**: `boolean` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:75 + +**Inherited from** + +[`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#iscaptchaavailable) + + + +Record<string, string | boolean | string[] | Record<string, string[]> | PhonePrefix[] | PasskeyCreate>}> +> **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`](/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#data) + + + + +> **links**: `Record`\<`string`, `string`\> \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:77 + +**Inherited from** + +[`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#links) + + + + +> **texts**: `Record`\<`string`, `string`\> \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:78 + +**Inherited from** + +[`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#texts) + + + +CaptchaContext}> +> **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`](/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#captcha) + + + + + + + + + + + + + + + + + + + + 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..32eb7ee2f --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaRecoveryCodeChallengeNewCode.mdx @@ -0,0 +1,108 @@ +--- +title: "ScreenMembersOnMfaRecoveryCodeChallengeNewCode" +--- + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/mfa-recovery-code-challenge-new-code.d.ts:10 + +ScreenMembersOnMfaRecoveryCodeChallengeNewCode + +- Extends [`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers) + +## Properties + + +> **name**: `string` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:71 + +**Inherited from** + +[`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#name) + + + + +> **captchaImage**: `string` \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:72 + +**Inherited from** + +[`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#captchaimage) + + + + +> **captchaSiteKey**: `string` \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:73 + +**Inherited from** + +[`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#captchasitekey) + + + + +> **captchaProvider**: `string` \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:74 + +**Inherited from** + +[`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#captchaprovider) + + + + +> **isCaptchaAvailable**: `boolean` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:75 + +**Inherited from** + +[`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#iscaptchaavailable) + + + + +> **links**: `Record`\<`string`, `string`\> \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:77 + +**Inherited from** + +[`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#links) + + + + +> **texts**: `Record`\<`string`, `string`\> \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:78 + +**Inherited from** + +[`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#texts) + + + +CaptchaContext}> +> **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`](/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#captcha) + + + + + + + + + + + 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..1833f0318 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaRecoveryCodeEnrollment.mdx @@ -0,0 +1,108 @@ +--- +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`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers) + +## Properties + + +> **name**: `string` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:71 + +**Inherited from** + +[`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#name) + + + + +> **captchaImage**: `string` \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:72 + +**Inherited from** + +[`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#captchaimage) + + + + +> **captchaSiteKey**: `string` \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:73 + +**Inherited from** + +[`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#captchasitekey) + + + + +> **captchaProvider**: `string` \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:74 + +**Inherited from** + +[`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#captchaprovider) + + + + +> **isCaptchaAvailable**: `boolean` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:75 + +**Inherited from** + +[`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#iscaptchaavailable) + + + + +> **links**: `Record`\<`string`, `string`\> \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:77 + +**Inherited from** + +[`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#links) + + + + +> **texts**: `Record`\<`string`, `string`\> \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:78 + +**Inherited from** + +[`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#texts) + + + +CaptchaContext}> +> **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`](/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#captcha) + + + + + + + + + + + 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..f0a9c3748 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaSmsChallenge.mdx @@ -0,0 +1,114 @@ +--- +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`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers) + +## Properties + + +> **name**: `string` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:71 + +**Inherited from** + +[`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#name) + + + + +> **captchaImage**: `string` \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:72 + +**Inherited from** + +[`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#captchaimage) + + + + +> **captchaSiteKey**: `string` \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:73 + +**Inherited from** + +[`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#captchasitekey) + + + + +> **captchaProvider**: `string` \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:74 + +**Inherited from** + +[`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#captchaprovider) + + + + +> **isCaptchaAvailable**: `boolean` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:75 + +**Inherited from** + +[`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#iscaptchaavailable) + + + + +> **links**: `Record`\<`string`, `string`\> \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:77 + +**Inherited from** + +[`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#links) + + + + +> **texts**: `Record`\<`string`, `string`\> \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:78 + +**Inherited from** + +[`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#texts) + + + +CaptchaContext}> +> **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`](/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#captcha) + + + + + + + + + + + + + + + + + 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..ed3c5c9fe --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaSmsEnrollment.mdx @@ -0,0 +1,106 @@ +--- +title: "ScreenMembersOnMfaSmsEnrollment" +--- + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/mfa-sms-enrollment.d.ts:9 + +- Extends [`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers) + +## Properties + + +> **name**: `string` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:71 + +**Inherited from** + +[`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#name) + + + + +> **captchaImage**: `string` \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:72 + +**Inherited from** + +[`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#captchaimage) + + + + +> **captchaSiteKey**: `string` \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:73 + +**Inherited from** + +[`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#captchasitekey) + + + + +> **captchaProvider**: `string` \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:74 + +**Inherited from** + +[`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#captchaprovider) + + + + +> **isCaptchaAvailable**: `boolean` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:75 + +**Inherited from** + +[`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#iscaptchaavailable) + + + + +> **links**: `Record`\<`string`, `string`\> \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:77 + +**Inherited from** + +[`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#links) + + + + +> **texts**: `Record`\<`string`, `string`\> \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:78 + +**Inherited from** + +[`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#texts) + + + +CaptchaContext}> +> **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`](/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#captcha) + + + + + + + + + + + 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..833bebf40 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaVoiceChallenge.mdx @@ -0,0 +1,114 @@ +--- +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`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers) + +## Properties + + +> **name**: `string` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:71 + +**Inherited from** + +[`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#name) + + + + +> **captchaImage**: `string` \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:72 + +**Inherited from** + +[`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#captchaimage) + + + + +> **captchaSiteKey**: `string` \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:73 + +**Inherited from** + +[`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#captchasitekey) + + + + +> **captchaProvider**: `string` \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:74 + +**Inherited from** + +[`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#captchaprovider) + + + + +> **isCaptchaAvailable**: `boolean` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:75 + +**Inherited from** + +[`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#iscaptchaavailable) + + + + +> **links**: `Record`\<`string`, `string`\> \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:77 + +**Inherited from** + +[`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#links) + + + + +> **texts**: `Record`\<`string`, `string`\> \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:78 + +**Inherited from** + +[`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#texts) + + + +CaptchaContext}> +> **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`](/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#captcha) + + + + + + + + + + + + + + + + + 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..8f2257bbf --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaWebAuthnChangeKeyNickname.mdx @@ -0,0 +1,108 @@ +--- +title: "ScreenMembersOnMfaWebAuthnChangeKeyNickname" +--- + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/mfa-webauthn-change-key-nickname.d.ts:14 + +ScreenMembersOnMfaWebAuthnChangeKeyNickname + +- Extends [`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers) + +## Properties + + +> **name**: `string` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:71 + +**Inherited from** + +[`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#name) + + + + +> **captchaImage**: `string` \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:72 + +**Inherited from** + +[`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#captchaimage) + + + + +> **captchaSiteKey**: `string` \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:73 + +**Inherited from** + +[`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#captchasitekey) + + + + +> **captchaProvider**: `string` \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:74 + +**Inherited from** + +[`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#captchaprovider) + + + + +> **isCaptchaAvailable**: `boolean` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:75 + +**Inherited from** + +[`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#iscaptchaavailable) + + + + +> **links**: `Record`\<`string`, `string`\> \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:77 + +**Inherited from** + +[`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#links) + + + + +> **texts**: `Record`\<`string`, `string`\> \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:78 + +**Inherited from** + +[`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#texts) + + + +CaptchaContext}> +> **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`](/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#captcha) + + + + + + + + + + + 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..821cfaa3a --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaWebAuthnEnrollmentSuccess.mdx @@ -0,0 +1,111 @@ +--- +title: "ScreenMembersOnMfaWebAuthnEnrollmentSuccess" +--- + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/mfa-webauthn-enrollment-success.d.ts:16 + +ScreenMembersOnMfaWebAuthnEnrollmentSuccess + +- Extends [`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers) + +## Properties + + +> **name**: `string` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:71 + +**Inherited from** + +[`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#name) + + + + +> **captchaImage**: `string` \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:72 + +**Inherited from** + +[`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#captchaimage) + + + + +> **captchaSiteKey**: `string` \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:73 + +**Inherited from** + +[`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#captchasitekey) + + + + +> **captchaProvider**: `string` \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:74 + +**Inherited from** + +[`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#captchaprovider) + + + + +> **isCaptchaAvailable**: `boolean` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:75 + +**Inherited from** + +[`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#iscaptchaavailable) + + + + +> **links**: `Record`\<`string`, `string`\> \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:77 + +**Inherited from** + +[`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#links) + + + + +> **texts**: `Record`\<`string`, `string`\> \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:78 + +**Inherited from** + +[`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#texts) + + + +CaptchaContext}> +> **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`](/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#captcha) + + + + + + + + + + WebAuthnType}> + + + + 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..a001b9558 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaWebAuthnError.mdx @@ -0,0 +1,111 @@ +--- +title: "ScreenMembersOnMfaWebAuthnError" +--- + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/mfa-webauthn-error.d.ts:18 + +ScreenMembersOnMfaWebAuthnError + +- Extends [`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers) + +## Properties + + +> **name**: `string` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:71 + +**Inherited from** + +[`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#name) + + + + +> **captchaImage**: `string` \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:72 + +**Inherited from** + +[`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#captchaimage) + + + + +> **captchaSiteKey**: `string` \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:73 + +**Inherited from** + +[`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#captchasitekey) + + + + +> **captchaProvider**: `string` \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:74 + +**Inherited from** + +[`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#captchaprovider) + + + + +> **isCaptchaAvailable**: `boolean` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:75 + +**Inherited from** + +[`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#iscaptchaavailable) + + + + +> **links**: `Record`\<`string`, `string`\> \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:77 + +**Inherited from** + +[`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#links) + + + + +> **texts**: `Record`\<`string`, `string`\> \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:78 + +**Inherited from** + +[`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#texts) + + + +CaptchaContext}> +> **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`](/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#captcha) + + + + + + + + + + WebAuthnType}> + + + + 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..99ffc21e6 --- /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`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers) + +## Properties + + +> **name**: `string` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:71 + +**Inherited from** + +[`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#name) + + + + +> **captchaImage**: `string` \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:72 + +**Inherited from** + +[`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#captchaimage) + + + + +> **captchaSiteKey**: `string` \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:73 + +**Inherited from** + +[`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#captchasitekey) + + + + +> **captchaProvider**: `string` \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:74 + +**Inherited from** + +[`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#captchaprovider) + + + + +> **isCaptchaAvailable**: `boolean` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:75 + +**Inherited from** + +[`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#iscaptchaavailable) + + + +Record<string, string | boolean | string[] | Record<string, string[]> | PhonePrefix[] | PasskeyCreate>}> +> **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 + +Screen-specific data. + +**Inherited from** + +[`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#data) + + + + +> **links**: `Record`\<`string`, `string`\> \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:77 + +**Inherited from** + +[`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#links) + + + + +> **texts**: `Record`\<`string`, `string`\> \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:78 + +**Inherited from** + +[`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#texts) + + + +CaptchaContext}> +> **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`](/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#captcha) + + + + + + + + + + AllowCredential[]}> + + + + + + +> **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. + 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..723c52068 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaWebAuthnPlatformEnrollment.mdx @@ -0,0 +1,125 @@ +--- +title: "ScreenMembersOnMfaWebAuthnPlatformEnrollment" +--- + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/mfa-webauthn-platform-enrollment.d.ts:11 + +ScreenMembersOnMfaWebAuthnPlatformEnrollment + +- Extends [`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers) + +## Properties + + +> **name**: `string` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:71 + +**Inherited from** + +[`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#name) + + + + +> **captchaImage**: `string` \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:72 + +**Inherited from** + +[`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#captchaimage) + + + + +> **captchaSiteKey**: `string` \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:73 + +**Inherited from** + +[`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#captchasitekey) + + + + +> **captchaProvider**: `string` \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:74 + +**Inherited from** + +[`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#captchaprovider) + + + + +> **isCaptchaAvailable**: `boolean` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:75 + +**Inherited from** + +[`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#iscaptchaavailable) + + + +Record<string, string | boolean | string[] | Record<string, string[]> | PhonePrefix[] | PasskeyCreate>}> +> **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`](/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#data) + + + + +> **links**: `Record`\<`string`, `string`\> \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:77 + +**Inherited from** + +[`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#links) + + + + +> **texts**: `Record`\<`string`, `string`\> \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:78 + +**Inherited from** + +[`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#texts) + + + +CaptchaContext}> +> **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`](/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#captcha) + + + + + + + + + + + + + + + + + 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..871a95dde --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaWebAuthnRoamingChallenge.mdx @@ -0,0 +1,138 @@ +--- +title: "ScreenMembersOnMfaWebAuthnRoamingChallenge" +--- + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/mfa-webauthn-roaming-challenge.d.ts:16 + +ScreenMembersOnMfaWebAuthnRoamingChallenge + +- Extends [`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers) + +## Properties + + +> **name**: `string` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:71 + +**Inherited from** + +[`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#name) + + + + +> **captchaImage**: `string` \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:72 + +**Inherited from** + +[`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#captchaimage) + + + + +> **captchaSiteKey**: `string` \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:73 + +**Inherited from** + +[`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#captchasitekey) + + + + +> **captchaProvider**: `string` \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:74 + +**Inherited from** + +[`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#captchaprovider) + + + + +> **isCaptchaAvailable**: `boolean` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:75 + +**Inherited from** + +[`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#iscaptchaavailable) + + + +Record<string, string | boolean | string[] | Record<string, string[]> | PhonePrefix[] | PasskeyCreate>}> +> **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 + +Screen-specific data. + +**Inherited from** + +[`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#data) + + + + +> **links**: `Record`\<`string`, `string`\> \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:77 + +**Inherited from** + +[`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#links) + + + + +> **texts**: `Record`\<`string`, `string`\> \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:78 + +**Inherited from** + +[`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#texts) + + + +CaptchaContext}> +> **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`](/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#captcha) + + + + +> `optional` **showRememberDevice**: `boolean` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/mfa-webauthn-roaming-challenge.d.ts:17 + + + + +> **webauthnType**: `string` \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/mfa-webauthn-roaming-challenge.d.ts:18 + + + + + + + + + + AllowCredential[]}> + + + + 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..30d73a7e8 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnMfaWebAuthnRoamingEnrollment.mdx @@ -0,0 +1,132 @@ +--- +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`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers) + +## Properties + + +> **name**: `string` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:71 + +**Inherited from** + +[`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#name) + + + + +> **captchaImage**: `string` \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:72 + +**Inherited from** + +[`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#captchaimage) + + + + +> **captchaSiteKey**: `string` \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:73 + +**Inherited from** + +[`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#captchasitekey) + + + + +> **captchaProvider**: `string` \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:74 + +**Inherited from** + +[`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#captchaprovider) + + + + +> **isCaptchaAvailable**: `boolean` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:75 + +**Inherited from** + +[`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#iscaptchaavailable) + + + +Record<string, string | boolean | string[] | Record<string, string[]> | PhonePrefix[] | PasskeyCreate>}> +> **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`](/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#data) + + + + +> **links**: `Record`\<`string`, `string`\> \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:77 + +**Inherited from** + +[`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#links) + + + + +> **texts**: `Record`\<`string`, `string`\> \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:78 + +**Inherited from** + +[`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#texts) + + + +CaptchaContext}> +> **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`](/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#captcha) + + + + +> **webauthnType**: `string` \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/mfa-webauthn-roaming-enrollment.d.ts:8 + + + + + + + + + + + + + + + + + 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..83203533b --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnOrganizationSelection.mdx @@ -0,0 +1,151 @@ +--- +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`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers) + +## Properties + + +> **name**: `string` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:71 + +**Inherited from** + +[`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#name) + + + + +> **captchaImage**: `string` \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:72 + +**Inherited from** + +[`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#captchaimage) + + + + +> **captchaSiteKey**: `string` \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:73 + +**Inherited from** + +[`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#captchasitekey) + + + + +> **captchaProvider**: `string` \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:74 + +**Inherited from** + +[`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#captchaprovider) + + + + +> **isCaptchaAvailable**: `boolean` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:75 + +**Inherited from** + +[`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#iscaptchaavailable) + + + +Record<string, string | boolean | string[] | Record<string, string[]> | PhonePrefix[] | PasskeyCreate>}> +> **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`](/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#data) + + + + +> **links**: `Record`\<`string`, `string`\> \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:77 + +**Inherited from** + +[`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#links) + + + + +> **texts**: `Record`\<`string`, `string`\> \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:78 + +**Inherited from** + +[`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#texts) + + + +CaptchaContext}> +> **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`](/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#captcha) + + + +ClientMembers}> +> **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 + + + +OrganizationMembers}> +> **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 + + + +PromptMembers}> +> **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 + + + +ScreenMembers}> +> **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 + + + +TransactionMembers}> +> **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 + + + +UserMembers}> +> **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 + 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..d42c8ac9d --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnPasskeyEnrollment.mdx @@ -0,0 +1,137 @@ +--- +title: "ScreenMembersOnPasskeyEnrollment" +--- + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/passkey-enrollment.d.ts:15 + +- Extends [`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers) + +## Properties + + +> **name**: `string` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:71 + +**Inherited from** + +[`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#name) + + + + +> **captchaImage**: `string` \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:72 + +**Inherited from** + +[`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#captchaimage) + + + + +> **captchaSiteKey**: `string` \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:73 + +**Inherited from** + +[`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#captchasitekey) + + + + +> **captchaProvider**: `string` \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:74 + +**Inherited from** + +[`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#captchaprovider) + + + + +> **isCaptchaAvailable**: `boolean` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:75 + +**Inherited from** + +[`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#iscaptchaavailable) + + + +Record<string, string | boolean | string[] | Record<string, string[]> | PhonePrefix[] | PasskeyCreate>}> +> **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`](/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#data) + + + + +> **links**: `Record`\<`string`, `string`\> \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:77 + +**Inherited from** + +[`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#links) + + + + +> **texts**: `Record`\<`string`, `string`\> \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:78 + +**Inherited from** + +[`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#texts) + + + +CaptchaContext}> +> **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`](/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#captcha) + + + + +> **backLink**: `string` \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/passkey-enrollment.d.ts:16 + + + + +> **loginLink**: `string` \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/passkey-enrollment.d.ts:17 + + + + + + + + + + + + + + + + + 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..b60073a7f --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnPasskeyEnrollmentLocal.mdx @@ -0,0 +1,123 @@ +--- +title: "ScreenMembersOnPasskeyEnrollmentLocal" +--- + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/passkey-enrollment-local.d.ts:19 + +- Extends [`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers) + +## Properties + + +> **name**: `string` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:71 + +**Inherited from** + +[`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#name) + + + + +> **captchaImage**: `string` \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:72 + +**Inherited from** + +[`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#captchaimage) + + + + +> **captchaSiteKey**: `string` \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:73 + +**Inherited from** + +[`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#captchasitekey) + + + + +> **captchaProvider**: `string` \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:74 + +**Inherited from** + +[`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#captchaprovider) + + + + +> **isCaptchaAvailable**: `boolean` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:75 + +**Inherited from** + +[`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#iscaptchaavailable) + + + +Record<string, string | boolean | string[] | Record<string, string[]> | PhonePrefix[] | PasskeyCreate>}> +> **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`](/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#data) + + + + +> **links**: `Record`\<`string`, `string`\> \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:77 + +**Inherited from** + +[`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#links) + + + + +> **texts**: `Record`\<`string`, `string`\> \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:78 + +**Inherited from** + +[`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#texts) + + + +CaptchaContext}> +> **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`](/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#captcha) + + + + + + + + + + + + + + + + + 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..21a2f2d16 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnPhoneIdentifierChallenge.mdx @@ -0,0 +1,118 @@ +--- +title: "ScreenMembersOnPhoneIdentifierChallenge" +--- + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/phone-identifier-challenge.d.ts:22 + +- Extends [`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers) + +## Properties + + +> **name**: `string` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:71 + +**Inherited from** + +[`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#name) + + + + +> **captchaImage**: `string` \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:72 + +**Inherited from** + +[`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#captchaimage) + + + + +> **captchaSiteKey**: `string` \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:73 + +**Inherited from** + +[`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#captchasitekey) + + + + +> **captchaProvider**: `string` \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:74 + +**Inherited from** + +[`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#captchaprovider) + + + + +> **isCaptchaAvailable**: `boolean` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:75 + +**Inherited from** + +[`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#iscaptchaavailable) + + + + +> **links**: `Record`\<`string`, `string`\> \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:77 + +**Inherited from** + +[`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#links) + + + + +> **texts**: `Record`\<`string`, `string`\> \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:78 + +**Inherited from** + +[`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#texts) + + + +CaptchaContext}> +> **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`](/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#captcha) + + + + + + + + + + + + + + + + + + + + + + + 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..0760a5b82 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnPhoneIdentifierEnrollment.mdx @@ -0,0 +1,115 @@ +--- +title: "ScreenMembersOnPhoneIdentifierEnrollment" +--- + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/phone-identifier-enrollment.d.ts:8 + +- Extends [`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers) + +## Properties + + +> **name**: `string` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:71 + +**Inherited from** + +[`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#name) + + + + +> **captchaImage**: `string` \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:72 + +**Inherited from** + +[`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#captchaimage) + + + + +> **captchaSiteKey**: `string` \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:73 + +**Inherited from** + +[`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#captchasitekey) + + + + +> **captchaProvider**: `string` \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:74 + +**Inherited from** + +[`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#captchaprovider) + + + + +> **isCaptchaAvailable**: `boolean` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:75 + +**Inherited from** + +[`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#iscaptchaavailable) + + + + +> **links**: `Record`\<`string`, `string`\> \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:77 + +**Inherited from** + +[`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#links) + + + + +> **texts**: `Record`\<`string`, `string`\> \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:78 + +**Inherited from** + +[`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#texts) + + + +CaptchaContext}> +> **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`](/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#captcha) + + + + + + + + + + + + + + + + +> **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 new file mode 100644 index 000000000..b26b192b6 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnResetPassword.mdx @@ -0,0 +1,106 @@ +--- +title: "ScreenMembersOnResetPassword" +--- + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/reset-password.d.ts:13 + +- Extends [`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers) + +## Properties + + +> **name**: `string` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:71 + +**Inherited from** + +[`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#name) + + + + +> **captchaImage**: `string` \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:72 + +**Inherited from** + +[`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#captchaimage) + + + + +> **captchaSiteKey**: `string` \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:73 + +**Inherited from** + +[`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#captchasitekey) + + + + +> **captchaProvider**: `string` \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:74 + +**Inherited from** + +[`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#captchaprovider) + + + + +> **isCaptchaAvailable**: `boolean` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:75 + +**Inherited from** + +[`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#iscaptchaavailable) + + + + +> **links**: `Record`\<`string`, `string`\> \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:77 + +**Inherited from** + +[`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#links) + + + + +> **texts**: `Record`\<`string`, `string`\> \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:78 + +**Inherited from** + +[`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#texts) + + + +CaptchaContext}> +> **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`](/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#captcha) + + + + + + + + + + + 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..181c5d1a0 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnResetPasswordEmail.mdx @@ -0,0 +1,106 @@ +--- +title: "ScreenMembersOnResetPasswordEmail" +--- + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/reset-password-email.d.ts:10 + +- Extends [`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers) + +## Properties + + +> **name**: `string` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:71 + +**Inherited from** + +[`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#name) + + + + +> **captchaImage**: `string` \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:72 + +**Inherited from** + +[`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#captchaimage) + + + + +> **captchaSiteKey**: `string` \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:73 + +**Inherited from** + +[`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#captchasitekey) + + + + +> **captchaProvider**: `string` \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:74 + +**Inherited from** + +[`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#captchaprovider) + + + + +> **isCaptchaAvailable**: `boolean` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:75 + +**Inherited from** + +[`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#iscaptchaavailable) + + + + +> **links**: `Record`\<`string`, `string`\> \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:77 + +**Inherited from** + +[`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#links) + + + + +> **texts**: `Record`\<`string`, `string`\> \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:78 + +**Inherited from** + +[`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#texts) + + + +CaptchaContext}> +> **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`](/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#captcha) + + + + + + + + + + + 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..6905cbe01 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnResetPasswordError.mdx @@ -0,0 +1,106 @@ +--- +title: "ScreenMembersOnResetPasswordError" +--- + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/reset-password-error.d.ts:9 + +- Extends [`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers) + +## Properties + + +> **name**: `string` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:71 + +**Inherited from** + +[`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#name) + + + + +> **captchaImage**: `string` \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:72 + +**Inherited from** + +[`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#captchaimage) + + + + +> **captchaSiteKey**: `string` \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:73 + +**Inherited from** + +[`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#captchasitekey) + + + + +> **captchaProvider**: `string` \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:74 + +**Inherited from** + +[`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#captchaprovider) + + + + +> **isCaptchaAvailable**: `boolean` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:75 + +**Inherited from** + +[`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#iscaptchaavailable) + + + + +> **links**: `Record`\<`string`, `string`\> \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:77 + +**Inherited from** + +[`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#links) + + + + +> **texts**: `Record`\<`string`, `string`\> \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:78 + +**Inherited from** + +[`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#texts) + + + +CaptchaContext}> +> **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`](/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#captcha) + + + + + + + + + + + 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..1df239241 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnResetPasswordMfaEmailChallenge.mdx @@ -0,0 +1,108 @@ +--- +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`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers) + +## Properties + + +> **name**: `string` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:71 + +**Inherited from** + +[`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#name) + + + + +> **captchaImage**: `string` \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:72 + +**Inherited from** + +[`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#captchaimage) + + + + +> **captchaSiteKey**: `string` \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:73 + +**Inherited from** + +[`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#captchasitekey) + + + + +> **captchaProvider**: `string` \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:74 + +**Inherited from** + +[`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#captchaprovider) + + + + +> **isCaptchaAvailable**: `boolean` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:75 + +**Inherited from** + +[`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#iscaptchaavailable) + + + + +> **links**: `Record`\<`string`, `string`\> \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:77 + +**Inherited from** + +[`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#links) + + + + +> **texts**: `Record`\<`string`, `string`\> \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:78 + +**Inherited from** + +[`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#texts) + + + +CaptchaContext}> +> **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`](/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#captcha) + + + + + + + + + + + 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..ed164770b --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnResetPasswordMfaPhoneChallenge.mdx @@ -0,0 +1,108 @@ +--- +title: "ScreenMembersOnResetPasswordMfaPhoneChallenge" +--- + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/reset-password-mfa-phone-challenge.d.ts:14 + +ScreenMembersOnResetPasswordMfaPhoneChallenge + +- Extends [`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers) + +## Properties + + +> **name**: `string` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:71 + +**Inherited from** + +[`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#name) + + + + +> **captchaImage**: `string` \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:72 + +**Inherited from** + +[`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#captchaimage) + + + + +> **captchaSiteKey**: `string` \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:73 + +**Inherited from** + +[`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#captchasitekey) + + + + +> **captchaProvider**: `string` \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:74 + +**Inherited from** + +[`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#captchaprovider) + + + + +> **isCaptchaAvailable**: `boolean` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:75 + +**Inherited from** + +[`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#iscaptchaavailable) + + + + +> **links**: `Record`\<`string`, `string`\> \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:77 + +**Inherited from** + +[`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#links) + + + + +> **texts**: `Record`\<`string`, `string`\> \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:78 + +**Inherited from** + +[`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#texts) + + + +CaptchaContext}> +> **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`](/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#captcha) + + + + + + + + + + + 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..fa5f6231a --- /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`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers) + +## Properties + + +> **name**: `string` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:71 + +**Inherited from** + +[`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#name) + + + + +> **captchaImage**: `string` \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:72 + +**Inherited from** + +[`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#captchaimage) + + + + +> **captchaSiteKey**: `string` \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:73 + +**Inherited from** + +[`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#captchasitekey) + + + + +> **captchaProvider**: `string` \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:74 + +**Inherited from** + +[`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#captchaprovider) + + + + +> **isCaptchaAvailable**: `boolean` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:75 + +**Inherited from** + +[`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#iscaptchaavailable) + + + + +> **links**: `Record`\<`string`, `string`\> \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:77 + +**Inherited from** + +[`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#links) + + + + +> **texts**: `Record`\<`string`, `string`\> \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:78 + +**Inherited from** + +[`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#texts) + + + +CaptchaContext}> +> **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`](/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#captcha) + + + + + + + + + + + + + + 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..13baec092 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnResetPasswordMfaSmsChallenge.mdx @@ -0,0 +1,109 @@ +--- +title: "ScreenMembersOnResetPasswordMfaSmsChallenge" +--- + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/reset-password-mfa-sms-challenge.d.ts:9 + +- Extends [`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers) + +## Properties + + +> **name**: `string` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:71 + +**Inherited from** + +[`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#name) + + + + +> **captchaImage**: `string` \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:72 + +**Inherited from** + +[`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#captchaimage) + + + + +> **captchaSiteKey**: `string` \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:73 + +**Inherited from** + +[`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#captchasitekey) + + + + +> **captchaProvider**: `string` \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:74 + +**Inherited from** + +[`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#captchaprovider) + + + + +> **isCaptchaAvailable**: `boolean` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:75 + +**Inherited from** + +[`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#iscaptchaavailable) + + + + +> **links**: `Record`\<`string`, `string`\> \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:77 + +**Inherited from** + +[`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#links) + + + + +> **texts**: `Record`\<`string`, `string`\> \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:78 + +**Inherited from** + +[`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#texts) + + + +CaptchaContext}> +> **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`](/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#captcha) + + + + + + + + + + + + + + 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..61cc885da --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnResetPasswordMfaVoiceChallenge.mdx @@ -0,0 +1,111 @@ +--- +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`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers) + +## Properties + + +> **name**: `string` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:71 + +**Inherited from** + +[`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#name) + + + + +> **captchaImage**: `string` \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:72 + +**Inherited from** + +[`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#captchaimage) + + + + +> **captchaSiteKey**: `string` \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:73 + +**Inherited from** + +[`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#captchasitekey) + + + + +> **captchaProvider**: `string` \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:74 + +**Inherited from** + +[`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#captchaprovider) + + + + +> **isCaptchaAvailable**: `boolean` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:75 + +**Inherited from** + +[`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#iscaptchaavailable) + + + + +> **links**: `Record`\<`string`, `string`\> \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:77 + +**Inherited from** + +[`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#links) + + + + +> **texts**: `Record`\<`string`, `string`\> \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:78 + +**Inherited from** + +[`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#texts) + + + +CaptchaContext}> +> **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`](/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#captcha) + + + + + + + + + + + + + + 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..83b9b272c --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnResetPasswordMfaWebAuthnPlatformChallenge.mdx @@ -0,0 +1,134 @@ +--- +title: "ScreenMembersOnResetPasswordMfaWebAuthnPlatformChallenge" +--- + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/reset-password-mfa-webauthn-platform-challenge.d.ts:28 + +ScreenMembersOnResetPasswordMfaWebAuthnPlatformChallenge + +- Extends [`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers) + +## Properties + + +> **name**: `string` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:71 + +**Inherited from** + +[`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#name) + + + + +> **captchaImage**: `string` \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:72 + +**Inherited from** + +[`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#captchaimage) + + + + +> **captchaSiteKey**: `string` \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:73 + +**Inherited from** + +[`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#captchasitekey) + + + + +> **captchaProvider**: `string` \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:74 + +**Inherited from** + +[`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#captchaprovider) + + + + +> **isCaptchaAvailable**: `boolean` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:75 + +**Inherited from** + +[`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#iscaptchaavailable) + + + +Record<string, string | boolean | string[] | Record<string, string[]> | PhonePrefix[] | PasskeyCreate>}> +> **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 + +Screen-specific data. + +**Inherited from** + +[`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#data) + + + + +> **links**: `Record`\<`string`, `string`\> \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:77 + +**Inherited from** + +[`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#links) + + + + +> **texts**: `Record`\<`string`, `string`\> \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:78 + +**Inherited from** + +[`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#texts) + + + +CaptchaContext}> +> **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`](/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#captcha) + + + + + + + + + + AllowCredential[]}> + + + + + + +> **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. + 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..c9cf0a612 --- /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`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers) + +## Properties + + +> **name**: `string` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:71 + +**Inherited from** + +[`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#name) + + + + +> **captchaImage**: `string` \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:72 + +**Inherited from** + +[`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#captchaimage) + + + + +> **captchaSiteKey**: `string` \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:73 + +**Inherited from** + +[`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#captchasitekey) + + + + +> **captchaProvider**: `string` \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:74 + +**Inherited from** + +[`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#captchaprovider) + + + + +> **isCaptchaAvailable**: `boolean` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:75 + +**Inherited from** + +[`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#iscaptchaavailable) + + + +Record<string, string | boolean | string[] | Record<string, string[]> | PhonePrefix[] | PasskeyCreate>}> +> **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 + +Screen-specific data, +including WebAuthn challenge options and the "show remember device" flag. + +**Inherited from** + +[`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#data) + + + + +> **links**: `Record`\<`string`, `string`\> \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:77 + +**Inherited from** + +[`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#links) + + + + +> **texts**: `Record`\<`string`, `string`\> \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:78 + +**Inherited from** + +[`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#texts) + + + +CaptchaContext}> +> **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`](/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#captcha) + + + + + + + + + + AllowCredential[]}> + + + + + + +> **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. + 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..641a85113 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnResetPasswordRequest.mdx @@ -0,0 +1,112 @@ +--- +title: "ScreenMembersOnResetPasswordRequest" +--- + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/reset-password-request.d.ts:16 + +- Extends [`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers) + +## Properties + + +> **name**: `string` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:71 + +**Inherited from** + +[`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#name) + + + + +> **captchaImage**: `string` \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:72 + +**Inherited from** + +[`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#captchaimage) + + + + +> **captchaSiteKey**: `string` \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:73 + +**Inherited from** + +[`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#captchasitekey) + + + + +> **captchaProvider**: `string` \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:74 + +**Inherited from** + +[`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#captchaprovider) + + + + +> **isCaptchaAvailable**: `boolean` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:75 + +**Inherited from** + +[`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#iscaptchaavailable) + + + + +> **links**: `Record`\<`string`, `string`\> \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:77 + +**Inherited from** + +[`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#links) + + + + +> **texts**: `Record`\<`string`, `string`\> \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:78 + +**Inherited from** + +[`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#texts) + + + +CaptchaContext}> +> **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`](/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#captcha) + + + + + + + + + + + + + + + + + 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..ac9097aa3 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnResetPasswordSuccess.mdx @@ -0,0 +1,107 @@ +--- +title: "ScreenMembersOnResetPasswordSuccess" +--- + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/reset-password-success.d.ts:9 + +- Extends [`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers) + +## Properties + + +> **name**: `string` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:71 + +**Inherited from** + +[`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#name) + + + + +> **captchaImage**: `string` \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:72 + +**Inherited from** + +[`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#captchaimage) + + + + +> **captchaSiteKey**: `string` \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:73 + +**Inherited from** + +[`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#captchasitekey) + + + + +> **captchaProvider**: `string` \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:74 + +**Inherited from** + +[`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#captchaprovider) + + + + +> **isCaptchaAvailable**: `boolean` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:75 + +**Inherited from** + +[`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#iscaptchaavailable) + + + +Record<string, string | boolean | string[] | Record<string, string[]> | PhonePrefix[] | PasskeyCreate>}> +> **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`](/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#data) + + + + +> **links**: `Record`\<`string`, `string`\> \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:77 + +**Inherited from** + +[`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#links) + + + + +> **texts**: `Record`\<`string`, `string`\> \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:78 + +**Inherited from** + +[`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#texts) + + + +CaptchaContext}> +> **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`](/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#captcha) + 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..37c1d6235 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnSignup.mdx @@ -0,0 +1,114 @@ +--- +title: "ScreenMembersOnSignup" +--- + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/signup.d.ts:21 + +- Extends [`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers) + +## Properties + + +> **name**: `string` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:71 + +**Inherited from** + +[`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#name) + + + + +> **captchaImage**: `string` \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:72 + +**Inherited from** + +[`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#captchaimage) + + + + +> **captchaSiteKey**: `string` \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:73 + +**Inherited from** + +[`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#captchasitekey) + + + + +> **captchaProvider**: `string` \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:74 + +**Inherited from** + +[`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#captchaprovider) + + + + +> **isCaptchaAvailable**: `boolean` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:75 + +**Inherited from** + +[`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#iscaptchaavailable) + + + +Record<string, string | boolean | string[] | Record<string, string[]> | PhonePrefix[] | PasskeyCreate>}> +> **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`](/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#data) + + + + +> **links**: `Record`\<`string`, `string`\> \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:77 + +**Inherited from** + +[`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#links) + + + + +> **texts**: `Record`\<`string`, `string`\> \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:78 + +**Inherited from** + +[`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#texts) + + + +CaptchaContext}> +> **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`](/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#captcha) + + + + +> **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 new file mode 100644 index 000000000..ed39a7a08 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnSignupId.mdx @@ -0,0 +1,114 @@ +--- +title: "ScreenMembersOnSignupId" +--- + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/signup-id.d.ts:22 + +- Extends [`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers) + +## Properties + + +> **name**: `string` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:71 + +**Inherited from** + +[`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#name) + + + + +> **captchaImage**: `string` \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:72 + +**Inherited from** + +[`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#captchaimage) + + + + +> **captchaSiteKey**: `string` \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:73 + +**Inherited from** + +[`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#captchasitekey) + + + + +> **captchaProvider**: `string` \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:74 + +**Inherited from** + +[`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#captchaprovider) + + + + +> **isCaptchaAvailable**: `boolean` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:75 + +**Inherited from** + +[`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#iscaptchaavailable) + + + +Record<string, string | boolean | string[] | Record<string, string[]> | PhonePrefix[] | PasskeyCreate>}> +> **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`](/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#data) + + + + +> **links**: `Record`\<`string`, `string`\> \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:77 + +**Inherited from** + +[`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#links) + + + + +> **texts**: `Record`\<`string`, `string`\> \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:78 + +**Inherited from** + +[`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#texts) + + + +CaptchaContext}> +> **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`](/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#captcha) + + + + +> **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 new file mode 100644 index 000000000..f5b1ed1cb --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembersOnSignupPassword.mdx @@ -0,0 +1,126 @@ +--- +title: "ScreenMembersOnSignupPassword" +--- + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/signup-password.d.ts:24 + +- Extends [`ScreenMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/ScreenMembers) + +## Properties + + +> **name**: `string` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:71 + +**Inherited from** + +[`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#name) + + + + +> **captchaImage**: `string` \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:72 + +**Inherited from** + +[`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#captchaimage) + + + + +> **captchaSiteKey**: `string` \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:73 + +**Inherited from** + +[`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#captchasitekey) + + + + +> **captchaProvider**: `string` \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:74 + +**Inherited from** + +[`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#captchaprovider) + + + + +> **isCaptchaAvailable**: `boolean` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:75 + +**Inherited from** + +[`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#iscaptchaavailable) + + + + +> **links**: `Record`\<`string`, `string`\> \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:77 + +**Inherited from** + +[`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#links) + + + + +> **texts**: `Record`\<`string`, `string`\> \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/screen.d.ts:78 + +**Inherited from** + +[`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#texts) + + + +CaptchaContext}> +> **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`](/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#captcha) + + + + +> **loginLink**: `string` \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/signup-password.d.ts:25 + + + + +> **editLink**: `string` \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/signup-password.d.ts:26 + + + + + + + + + + + + + + + + + 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 + + +> **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') + + + + +> **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') + 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 + + +> **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. + 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 + + +> **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. + 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 + + +> **organization**: `string` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/organization-picker.d.ts:4 + + + + +> **state**: `string` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/organization-picker.d.ts:5 + 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..b7911d973 --- /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`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/WebAuthnErrorDetails) \| `undefined` + +Any additional custom options. + +## Properties + +WebAuthnErrorDetails}> +> **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 + +The details of the WebAuthn error. + 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..7c29476e1 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/SignupIdMembers.mdx @@ -0,0 +1,187 @@ +--- +title: "SignupIdMembers" +--- + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/signup-id.d.ts:46 + +- Extends [`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers) + +## Properties + +BrandingMembers}> +> **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`](/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#branding) + + + +ClientMembers}> +> **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`](/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#client) + + + +OrganizationMembers}> +> **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`](/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#organization) + + + +PromptMembers}> +> **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`](/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#prompt) + + + +TenantMembers}> +> **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`](/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#tenant) + + + +UserMembers}> +> **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`](/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#user) + + + +UntrustedDataMembers}> +> **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`](/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#untrusteddata) + + + +ScreenMembersOnSignupId}> +> **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`](/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#screen) + + + +TransactionMembersOnSignupId}> +> **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`](/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#transaction) + +**Methods** + + + +> **signup**(`payload`): `Promise`\<`void`\> + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/signup-id.d.ts:49 + +**Parameters** + +**payload** + +[`SignupOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/SignupOptions) + +**Returns** + +`Promise`\<`void`\> + + + + +> **federatedSignup**(`payload`): `Promise`\<`void`\> + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/signup-id.d.ts:50 + +**Parameters** + +**payload** + +[`FederatedSignupOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/FederatedSignupOptions) + +**Returns** + +`Promise`\<`void`\> + + + + +> **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`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/Identifier)[] \| `null` + + + + +> **pickCountryCode**(`payload?`): `Promise`\<`void`\> + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/signup-id.d.ts:52 + +**Parameters** + +**payload?** + +[`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CustomOptions) + +**Returns** + +`Promise`\<`void`\> + + + + +> **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 + +**Parameters** + +**username** + +`string` + +**Returns** + +[`UsernameValidationResult`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UsernameValidationResult) + 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..700cefb64 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/SignupMembers.mdx @@ -0,0 +1,229 @@ +--- +title: "SignupMembers" +--- + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/signup.d.ts:31 + +- Extends [`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers) + +## Properties + +BrandingMembers}> +> **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`](/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#branding) + + + +ClientMembers}> +> **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`](/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#client) + + + +OrganizationMembers}> +> **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`](/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#organization) + + + +PromptMembers}> +> **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`](/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#prompt) + + + +TenantMembers}> +> **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`](/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#tenant) + + + +UserMembers}> +> **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`](/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#user) + + + +UntrustedDataMembers}> +> **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`](/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#untrusteddata) + + + +ScreenMembersOnSignup}> +> **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`](/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#screen) + + + +TransactionMembersOnSignup}> +> **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`](/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#transaction) + +**Methods** + + + +> **signup**(`payload`): `Promise`\<`void`\> + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/signup.d.ts:34 + +**Parameters** + +**payload** + +[`SignupPayloadOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/SignupPayloadOptions) + +**Returns** + +`Promise`\<`void`\> + + + + +> **federatedSignup**(`payload`): `Promise`\<`void`\> + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/signup.d.ts:35 + +**Parameters** + +**payload** + +[`FederatedSignupPayloadOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/FederatedSignupPayloadOptions) + +**Returns** + +`Promise`\<`void`\> + + + + +> **pickCountryCode**(`payload?`): `Promise`\<`void`\> + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/signup.d.ts:36 + +**Parameters** + +**payload?** + +[`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CustomOptions) + +**Returns** + +`Promise`\<`void`\> + + + + +> **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 + +**Parameters** + +**password** + +`string` + +**Returns** + +[`PasswordValidationResult`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PasswordValidationResult) + + + + +> **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 + +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/react-sdk/API-Reference/Types/interfaces/Identifier)[] \| `null` + +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** + +```ts +const identifiers = authClient.getSignupIdentifiers(); +if (identifiers) { + identifiers.forEach(({ type, required }) => { + console.log(`${type} is ${required ? 'required' : 'optional'}`); + }); +} +``` + +**Utility Feature** + +**See** + +Identifier + + + + +> **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 + +**Parameters** + +**username** + +`string` + +**Returns** + +[`UsernameValidationResult`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UsernameValidationResult) + 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 + + +> `optional` **email**: `string` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/signup-id.d.ts:40 + + + + +> `optional` **username**: `string` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/signup-id.d.ts:41 + + + + +> `optional` **phone**: `string` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/signup-id.d.ts:42 + + + + +> `optional` **captcha**: `string` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/signup-id.d.ts:43 + 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..c8d56f15f --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/SignupPasswordMembers.mdx @@ -0,0 +1,159 @@ +--- +title: "SignupPasswordMembers" +--- + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/signup-password.d.ts:47 + +- Extends [`BaseMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/BaseMembers) + +## Properties + +BrandingMembers}> +> **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`](/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#branding) + + + +ClientMembers}> +> **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`](/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#client) + + + +OrganizationMembers}> +> **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`](/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#organization) + + + +PromptMembers}> +> **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`](/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#prompt) + + + +TenantMembers}> +> **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`](/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#tenant) + + + +UserMembers}> +> **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`](/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#user) + + + +UntrustedDataMembers}> +> **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`](/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#untrusteddata) + + + +ScreenMembersOnSignupPassword}> +> **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`](/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#screen) + + + +TransactionMembersOnSignupPassword}> +> **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`](/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#transaction) + +**Methods** + + + +> **signup**(`payload`): `Promise`\<`void`\> + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/signup-password.d.ts:50 + +**Parameters** + +**payload** + +[`SignupPasswordOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/SignupPasswordOptions) + +**Returns** + +`Promise`\<`void`\> + + + + +> **federatedSignup**(`payload`): `Promise`\<`void`\> + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/signup-password.d.ts:51 + +**Parameters** + +**payload** + +[`FederatedSignupPasswordPayloadOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/FederatedSignupPasswordPayloadOptions) + +**Returns** + +`Promise`\<`void`\> + + + + +> **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 + +**Parameters** + +**password** + +`string` + +**Returns** + +[`PasswordValidationResult`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PasswordValidationResult) + 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 + + +> `optional` **email**: `string` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/signup-password.d.ts:40 + + + + +> `optional` **username**: `string` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/signup-password.d.ts:41 + + + + +> `optional` **phoneNumber**: `string` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/signup-password.d.ts:42 + + + + +> **password**: `string` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/signup-password.d.ts:43 + + + + +> `optional` **captcha**: `string` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/signup-password.d.ts:44 + 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 + + +> `optional` **email**: `string` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/signup.d.ts:10 + + + + +> `optional` **username**: `string` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/signup.d.ts:11 + + + + +> `optional` **phoneNumber**: `string` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/signup.d.ts:12 + + + + +> `optional` **password**: `string` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/signup.d.ts:13 + + + + +> `optional` **captcha**: `string` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/signup.d.ts:14 + 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..cbe9ababf --- /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 + + +> `optional` **timeoutSeconds**: `number` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/utils/resend-control.d.ts:11 + + + +OnStatusChangeCallback}> +> `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 + + + + +> `optional` **onTimeout**: () => `void` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/utils/resend-control.d.ts:13 + +**Returns** + +`void` + 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 + + +> **captcha**: `string` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/interstitial-captcha.d.ts:3 + 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..c4c93be82 --- /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 + + +> **code**: `string` \| `number` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/login-passwordless-email-code.d.ts:19 + + + + +> `optional` **captcha**: `string` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/login-passwordless-email-code.d.ts:20 + 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 + + +> `optional` **username**: `string` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/login-passwordless-sms-otp.d.ts:26 + + + + +> **code**: `string` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/login-passwordless-sms-otp.d.ts:27 + + + + +> `optional` **captcha**: `string` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/login-passwordless-sms-otp.d.ts:28 + 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..dff2af182 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/SubmitPasskeyCredentialOptions.mdx @@ -0,0 +1,13 @@ +--- +title: "SubmitPasskeyCredentialOptions" +--- + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/mfa-webauthn-platform-enrollment.d.ts:27 + +SubmitPasskeyCredentialOptions + +- Extends [`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/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/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..c5d795f68 --- /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 + + +> **name**: `string` \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/tenant.d.ts:8 + + + + +> **friendlyName**: `string` \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/tenant.d.ts:9 + + + + +> **enabledLocales**: `string`[] \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/tenant.d.ts:10 + + + + +> **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 new file mode 100644 index 000000000..d13055e36 --- /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`](/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 + + +> **state**: `string` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/transaction.d.ts:152 + + + + +> **locale**: `string` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/transaction.d.ts:153 + + + + +> **countryCode**: `string` \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/transaction.d.ts:154 + + + + +> **countryPrefix**: `string` \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/transaction.d.ts:155 + + + + +> **connectionStrategy**: `string` \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/transaction.d.ts:156 + + + + +> **hasErrors**: `boolean` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/transaction.d.ts:157 + + + +Error[]}> +> **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 + + + +Connection}> +> **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 + + + +(Connection | EnterpriseConnection)[]}> +> **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 new file mode 100644 index 000000000..b38800c06 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembersOnLogin.mdx @@ -0,0 +1,144 @@ +--- +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`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers) + +## Properties + + +> **state**: `string` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/transaction.d.ts:152 + +**Inherited from** + +[`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#state) + + + + +> **locale**: `string` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/transaction.d.ts:153 + +**Inherited from** + +[`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#locale) + + + + +> **countryCode**: `string` \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/transaction.d.ts:154 + +**Inherited from** + +[`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#countrycode) + + + + +> **countryPrefix**: `string` \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/transaction.d.ts:155 + +**Inherited from** + +[`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#countryprefix) + + + + +> **connectionStrategy**: `string` \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/transaction.d.ts:156 + +**Inherited from** + +[`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#connectionstrategy) + + + + +> **hasErrors**: `boolean` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/transaction.d.ts:157 + +**Inherited from** + +[`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#haserrors) + + + +Error[]}> +> **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`](/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#errors) + + + +Connection}> +> **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`](/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#currentconnection) + + + +(Connection | EnterpriseConnection)[]}> +> **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`](/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#alternateconnections) + + + + +> **isSignupEnabled**: `boolean` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/login.d.ts:35 + + + + +> **isForgotPasswordEnabled**: `boolean` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/login.d.ts:36 + + + + +> **isPasskeyEnabled**: `boolean` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/login.d.ts:37 + + + +PasswordPolicy}> +> **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 + + + +IdentifierType[]}> +> **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 new file mode 100644 index 000000000..3df08b3a5 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembersOnLoginId.mdx @@ -0,0 +1,149 @@ +--- +title: "TransactionMembersOnLoginId" +--- + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/login-id.d.ts:31 + +- Extends [`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers) + +## Properties + + +> **state**: `string` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/transaction.d.ts:152 + +**Inherited from** + +[`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#state) + + + + +> **locale**: `string` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/transaction.d.ts:153 + +**Inherited from** + +[`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#locale) + + + + +> **countryCode**: `string` \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/transaction.d.ts:154 + +**Inherited from** + +[`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#countrycode) + + + + +> **countryPrefix**: `string` \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/transaction.d.ts:155 + +**Inherited from** + +[`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#countryprefix) + + + + +> **connectionStrategy**: `string` \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/transaction.d.ts:156 + +**Inherited from** + +[`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#connectionstrategy) + + + + +> **hasErrors**: `boolean` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/transaction.d.ts:157 + +**Inherited from** + +[`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#haserrors) + + + +Error[]}> +> **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`](/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#errors) + + + +Connection}> +> **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`](/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#currentconnection) + + + +(Connection | EnterpriseConnection)[]}> +> **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`](/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#alternateconnections) + + + + +> **isSignupEnabled**: `boolean` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/login-id.d.ts:32 + + + + +> **isPasskeyEnabled**: `boolean` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/login-id.d.ts:33 + + + + +> **isForgotPasswordEnabled**: `boolean` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/login-id.d.ts:34 + + + + +> **isUsernameRequired**: `boolean` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/login-id.d.ts:35 + + + +UsernamePolicy}> +> **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 + + + +IdentifierType[]}> +> **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 new file mode 100644 index 000000000..1c1960500 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembersOnLoginPassword.mdx @@ -0,0 +1,162 @@ +--- +title: "TransactionMembersOnLoginPassword" +--- + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/login-password.d.ts:23 + +- Extends [`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers) + +## Properties + + +> **state**: `string` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/transaction.d.ts:152 + +**Inherited from** + +[`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#state) + + + + +> **locale**: `string` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/transaction.d.ts:153 + +**Inherited from** + +[`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#locale) + + + + +> **countryCode**: `string` \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/transaction.d.ts:154 + +**Inherited from** + +[`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#countrycode) + + + + +> **countryPrefix**: `string` \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/transaction.d.ts:155 + +**Inherited from** + +[`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#countryprefix) + + + + +> **connectionStrategy**: `string` \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/transaction.d.ts:156 + +**Inherited from** + +[`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#connectionstrategy) + + + + +> **hasErrors**: `boolean` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/transaction.d.ts:157 + +**Inherited from** + +[`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#haserrors) + + + +Error[]}> +> **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`](/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#errors) + + + +Connection}> +> **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`](/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#currentconnection) + + + +(Connection | EnterpriseConnection)[]}> +> **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`](/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#alternateconnections) + + + + +> **isSignupEnabled**: `boolean` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/login-password.d.ts:24 + + + + +> **isForgotPasswordEnabled**: `boolean` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/login-password.d.ts:25 + + + + +> **isPasskeyEnabled**: `boolean` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/login-password.d.ts:26 + +**Methods** + + + +> **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`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/PasswordPolicy) \| `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`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UsernamePolicy) \| `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`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/type-aliases/IdentifierType)[] \| `null` + 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..300922836 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembersOnLoginPasswordlessEmailCode.mdx @@ -0,0 +1,114 @@ +--- +title: "TransactionMembersOnLoginPasswordlessEmailCode" +--- + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/login-passwordless-email-code.d.ts:15 + +- Extends [`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers) + +## Properties + + +> **state**: `string` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/transaction.d.ts:152 + +**Inherited from** + +[`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#state) + + + + +> **locale**: `string` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/transaction.d.ts:153 + +**Inherited from** + +[`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#locale) + + + + +> **countryCode**: `string` \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/transaction.d.ts:154 + +**Inherited from** + +[`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#countrycode) + + + + +> **countryPrefix**: `string` \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/transaction.d.ts:155 + +**Inherited from** + +[`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#countryprefix) + + + + +> **connectionStrategy**: `string` \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/transaction.d.ts:156 + +**Inherited from** + +[`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#connectionstrategy) + + + + +> **hasErrors**: `boolean` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/transaction.d.ts:157 + +**Inherited from** + +[`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#haserrors) + + + +Error[]}> +> **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`](/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#errors) + + + +Connection}> +> **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`](/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#currentconnection) + + + +(Connection | EnterpriseConnection)[]}> +> **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`](/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#alternateconnections) + + + + +> **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 new file mode 100644 index 000000000..7713b10da --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembersOnLoginPasswordlessSmsOtp.mdx @@ -0,0 +1,114 @@ +--- +title: "TransactionMembersOnLoginPasswordlessSmsOtp" +--- + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/login-passwordless-sms-otp.d.ts:22 + +- Extends [`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers) + +## Properties + + +> **state**: `string` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/transaction.d.ts:152 + +**Inherited from** + +[`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#state) + + + + +> **locale**: `string` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/transaction.d.ts:153 + +**Inherited from** + +[`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#locale) + + + + +> **countryCode**: `string` \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/transaction.d.ts:154 + +**Inherited from** + +[`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#countrycode) + + + + +> **countryPrefix**: `string` \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/transaction.d.ts:155 + +**Inherited from** + +[`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#countryprefix) + + + + +> **connectionStrategy**: `string` \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/transaction.d.ts:156 + +**Inherited from** + +[`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#connectionstrategy) + + + + +> **hasErrors**: `boolean` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/transaction.d.ts:157 + +**Inherited from** + +[`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#haserrors) + + + +Error[]}> +> **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`](/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#errors) + + + +Connection}> +> **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`](/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#currentconnection) + + + +(Connection | EnterpriseConnection)[]}> +> **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`](/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#alternateconnections) + + + + +> **isSignupEnabled**: `boolean` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/login-passwordless-sms-otp.d.ts:23 + 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..25bc60a45 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembersOnResetPassword.mdx @@ -0,0 +1,114 @@ +--- +title: "TransactionMembersOnResetPassword" +--- + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/reset-password.d.ts:18 + +- Extends [`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers) + +## Properties + + +> **state**: `string` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/transaction.d.ts:152 + +**Inherited from** + +[`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#state) + + + + +> **locale**: `string` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/transaction.d.ts:153 + +**Inherited from** + +[`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#locale) + + + + +> **countryCode**: `string` \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/transaction.d.ts:154 + +**Inherited from** + +[`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#countrycode) + + + + +> **countryPrefix**: `string` \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/transaction.d.ts:155 + +**Inherited from** + +[`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#countryprefix) + + + + +> **connectionStrategy**: `string` \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/transaction.d.ts:156 + +**Inherited from** + +[`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#connectionstrategy) + + + + +> **hasErrors**: `boolean` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/transaction.d.ts:157 + +**Inherited from** + +[`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#haserrors) + + + +Error[]}> +> **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`](/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#errors) + + + +Connection}> +> **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`](/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#currentconnection) + + + +(Connection | EnterpriseConnection)[]}> +> **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`](/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#alternateconnections) + + + +PasswordPolicy}> +> **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 new file mode 100644 index 000000000..201f8a11f --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembersOnResetPasswordRequest.mdx @@ -0,0 +1,128 @@ +--- +title: "TransactionMembersOnResetPasswordRequest" +--- + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/reset-password-request.d.ts:11 + +- Extends [`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers) + +## Properties + + +> **state**: `string` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/transaction.d.ts:152 + +**Inherited from** + +[`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#state) + + + + +> **locale**: `string` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/transaction.d.ts:153 + +**Inherited from** + +[`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#locale) + + + + +> **countryCode**: `string` \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/transaction.d.ts:154 + +**Inherited from** + +[`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#countrycode) + + + + +> **countryPrefix**: `string` \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/transaction.d.ts:155 + +**Inherited from** + +[`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#countryprefix) + + + + +> **connectionStrategy**: `string` \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/transaction.d.ts:156 + +**Inherited from** + +[`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#connectionstrategy) + + + + +> **hasErrors**: `boolean` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/transaction.d.ts:157 + +**Inherited from** + +[`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#haserrors) + + + +Error[]}> +> **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`](/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#errors) + + + +Connection}> +> **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`](/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#currentconnection) + + + +(Connection | EnterpriseConnection)[]}> +> **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`](/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#alternateconnections) + + + +IdentifierType[]}> +> **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 + + + +IdentifierType[]}> +> **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 + + + + +> **hasFlexibleIdentifier**: `boolean` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/reset-password-request.d.ts:14 + 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..b55d57518 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembersOnSignup.mdx @@ -0,0 +1,142 @@ +--- +title: "TransactionMembersOnSignup" +--- + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/signup.d.ts:24 + +- Extends [`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers) + +## Properties + + +> **state**: `string` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/transaction.d.ts:152 + +**Inherited from** + +[`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#state) + + + + +> **locale**: `string` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/transaction.d.ts:153 + +**Inherited from** + +[`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#locale) + + + + +> **countryCode**: `string` \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/transaction.d.ts:154 + +**Inherited from** + +[`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#countrycode) + + + + +> **countryPrefix**: `string` \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/transaction.d.ts:155 + +**Inherited from** + +[`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#countryprefix) + + + + +> **connectionStrategy**: `string` \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/transaction.d.ts:156 + +**Inherited from** + +[`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#connectionstrategy) + + + + +> **hasErrors**: `boolean` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/transaction.d.ts:157 + +**Inherited from** + +[`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#haserrors) + + + +Error[]}> +> **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`](/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#errors) + + + +Connection}> +> **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`](/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#currentconnection) + + + +(Connection | EnterpriseConnection)[]}> +> **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`](/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#alternateconnections) + + + + +> **isPasskeyEnabled**: `boolean` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/signup.d.ts:25 + + + +UsernamePolicy}> +> **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 + + + +IdentifierType[]}> +> **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 + + + +IdentifierType[]}> +> **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 + + + +PasswordPolicy}> +> **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 new file mode 100644 index 000000000..55b3a47e4 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembersOnSignupId.mdx @@ -0,0 +1,135 @@ +--- +title: "TransactionMembersOnSignupId" +--- + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/signup-id.d.ts:25 + +- Extends [`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers) + +## Properties + + +> **state**: `string` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/transaction.d.ts:152 + +**Inherited from** + +[`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#state) + + + + +> **locale**: `string` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/transaction.d.ts:153 + +**Inherited from** + +[`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#locale) + + + + +> **countryCode**: `string` \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/transaction.d.ts:154 + +**Inherited from** + +[`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#countrycode) + + + + +> **countryPrefix**: `string` \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/transaction.d.ts:155 + +**Inherited from** + +[`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#countryprefix) + + + + +> **connectionStrategy**: `string` \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/transaction.d.ts:156 + +**Inherited from** + +[`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#connectionstrategy) + + + + +> **hasErrors**: `boolean` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/transaction.d.ts:157 + +**Inherited from** + +[`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#haserrors) + + + +Error[]}> +> **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`](/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#errors) + + + +Connection}> +> **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`](/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#currentconnection) + + + +(Connection | EnterpriseConnection)[]}> +> **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`](/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#alternateconnections) + + + + +> **isPasskeyEnabled**: `boolean` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/signup-id.d.ts:26 + + + +UsernamePolicy}> +> **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 + + + +IdentifierType[]}> +> **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 + + + +IdentifierType[]}> +> **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 new file mode 100644 index 000000000..075945a8f --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembersOnSignupPassword.mdx @@ -0,0 +1,135 @@ +--- +title: "TransactionMembersOnSignupPassword" +--- + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/signup-password.d.ts:33 + +- Extends [`TransactionMembers`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/TransactionMembers) + +## Properties + + +> **state**: `string` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/transaction.d.ts:152 + +**Inherited from** + +[`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#state) + + + + +> **locale**: `string` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/transaction.d.ts:153 + +**Inherited from** + +[`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#locale) + + + + +> **countryCode**: `string` \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/transaction.d.ts:154 + +**Inherited from** + +[`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#countrycode) + + + + +> **countryPrefix**: `string` \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/transaction.d.ts:155 + +**Inherited from** + +[`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#countryprefix) + + + + +> **connectionStrategy**: `string` \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/transaction.d.ts:156 + +**Inherited from** + +[`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#connectionstrategy) + + + + +> **hasErrors**: `boolean` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/transaction.d.ts:157 + +**Inherited from** + +[`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#haserrors) + + + +Error[]}> +> **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`](/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#errors) + + + +Connection}> +> **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`](/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#currentconnection) + + + +(Connection | EnterpriseConnection)[]}> +> **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`](/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#alternateconnections) + + + + +> **isPasskeyEnabled**: `boolean` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/signup-password.d.ts:34 + + + +PasswordPolicy}> +> **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 + + + +IdentifierType[]}> +> **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 + + + +IdentifierType[]}> +> **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/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..fc8a1bd69 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers.mdx @@ -0,0 +1,33 @@ +--- +title: "UntrustedDataMembers" +--- + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/untrusted-data.d.ts:13 + +## Extended by + +- [`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 new file mode 100644 index 000000000..714b04d29 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembersOnMfaEmailChallenge.mdx @@ -0,0 +1,29 @@ +--- +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`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers) + +## Properties + + + + + + + + + + + + + + + + + + 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..ef446c950 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembersOnMfaOtpChallenge.mdx @@ -0,0 +1,29 @@ +--- +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`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers) + +## Properties + + + + + + + + + + + + + + + + + + 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..6d55ae045 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembersOnMfaPushChallengePush.mdx @@ -0,0 +1,29 @@ +--- +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`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers) + +## Properties + + + + + + + + + + + + + + + + + + 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..08bc8656d --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembersOnMfaSmsChallenge.mdx @@ -0,0 +1,29 @@ +--- +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`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers) + +## Properties + + + + + + + + + + + + + + + + + + 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..f2293e063 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembersOnMfaVoiceChallenge.mdx @@ -0,0 +1,29 @@ +--- +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`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UntrustedDataMembers) + +## Properties + + + + + + + + + + + + + + + + + + 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..d086340dc --- /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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/hooks/common/errors.ts#L17) + +## Properties + + +> `optional` **includeDevErrors**: `boolean` + +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) + 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..90f9e62a5 --- /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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/hooks/common/errors.ts#L21) + +## Properties + +ErrorsResult}> +> **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/ebee146156ebee4e88d738e484964ac5977ebfb9/packages/auth0-acul-react/src/hooks/common/errors.ts#L22) + + + + +> **hasError**: `boolean` + +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) + + + + +> **dismiss**: (`id`) => `void` + +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** + +**id** + +`string` + +**Returns** + +`void` + + + + +> **dismissAll**: () => `void` + +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** + +`void` + 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..5ee4b6419 --- /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/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). + +## Properties + + +> `optional` **timeoutSeconds**: `number` + +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`. + + + + +> `optional` **onTimeout**: () => `void` + +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. + +**Returns** + +`void` + 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..7b6c3f4f9 --- /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/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). + +## Properties + + +> **remaining**: `number` + +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. + + + + +> **disabled**: `boolean` + +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. + + + + +> **startResend**: () => `void` + +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. + +**Returns** + +`void` + 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..61c7a9bdb --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UserMembers.mdx @@ -0,0 +1,95 @@ +--- +title: "UserMembers" +--- + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/user.d.ts:34 + +## Properties + + +> **id**: `string` \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/user.d.ts:35 + + + + +> **email**: `string` \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/user.d.ts:36 + + + + +> **username**: `string` \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/user.d.ts:37 + + + + +> **phoneNumber**: `string` \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/user.d.ts:38 + + + + +> **picture**: `string` \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/user.d.ts:39 + + + + +> **enrolledFactors**: `string`[] \| `null` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/user.d.ts:40 + + + +EnrolledEmail[]}> +> **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 + + + +EnrolledPhoneNumber[]}> +> **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 + + + +EnrolledDevice[]}> +> **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 + + + +Organizations[]}> +> **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/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..1d3b6db04 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/UsernamePolicy.mdx @@ -0,0 +1,33 @@ +--- +title: "UsernamePolicy" +--- + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/transaction.d.ts:42 + +## Properties + + +> `optional` **isActive**: `boolean` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/transaction.d.ts:43 + + + + +> **maxLength**: `number` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/transaction.d.ts:44 + + + + +> **minLength**: `number` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/models/transaction.d.ts:45 + + + + + + + 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 + + +> **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"` + + + + +> **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."` + + + + +> **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". + 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..b3cdebf75 --- /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 + + +> **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. + + + +UsernameValidationError[]}> +> **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](/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 new file mode 100644 index 000000000..5004c2058 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/VerifyPlatformAuthenticatorOptions.mdx @@ -0,0 +1,24 @@ +--- +title: "VerifyPlatformAuthenticatorOptions" +--- + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/mfa-webauthn-platform-challenge.d.ts:37 + +VerifyPlatformAuthenticatorOptions + +- Extends [`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CustomOptions) + +## Indexable + +\[`key`: `string`\]: `string` \| `number` \| `boolean` \| `undefined` + +## Properties + + +> `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. + 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..e119b91a4 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/VerifySecurityKeyOptions.mdx @@ -0,0 +1,24 @@ +--- +title: "VerifySecurityKeyOptions" +--- + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/mfa-webauthn-roaming-challenge.d.ts:29 + +VerifySecurityKeyOptions + +- Extends [`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CustomOptions) + +## Indexable + +\[`key`: `string`\]: `string` \| `number` \| `boolean` \| `undefined` + +## Properties + + +> `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. + 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..608ff31bf --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/WebAuthnEnrollSuccessContinueOptions.mdx @@ -0,0 +1,13 @@ +--- +title: "WebAuthnEnrollSuccessContinueOptions" +--- + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/mfa-webauthn-enrollment-success.d.ts:45 + +ContinueOptions + +- Extends [`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/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/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 + + +> **name**: `string` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/common/index.d.ts:12 + +The name of the error (e.g., "NotAllowedError"). + + + + +> **message**: `string` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/common/index.d.ts:16 + +The error message. + 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..6f353e2e1 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/WithRememberOptions.mdx @@ -0,0 +1,19 @@ +--- +title: "WithRememberOptions" +--- + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/mfa-push-challenge-push.d.ts:25 + +- Extends [`CustomOptions`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/interfaces/CustomOptions) + +## Indexable + +\[`key`: `string`\]: `string` \| `number` \| `boolean` \| `undefined` + +## Properties + + +> `optional` **rememberDevice**: `boolean` + +Defined in: packages/auth0-acul-js/dist/types/interfaces/screens/mfa-push-challenge-push.d.ts:26 + 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..9cb1e8ae0 --- /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/ebee146156ebee4e88d738e484964ac5977ebfb9/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..421a7ce43 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/type-aliases/MfaPollingOptions.mdx @@ -0,0 +1,72 @@ +--- +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](/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 + +- 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`](/docs/customize/login-pages/advanced-customizations/reference/react-sdk/API-Reference/Types/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..1531dbd41 --- /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](/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) 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..7e57822c8 --- /dev/null +++ b/main/docs/customize/login-pages/advanced-customizations/reference/react-sdk/navigation.json @@ -0,0 +1,403 @@ +{ + "group": "@auth0/auth0-acul-react", + "pages": [ + { + "group": "Hooks", + "pages": [ + "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": "Screens", + "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/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": "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" + ] + } + ] +}