Javascript API

Open a particular dialog

UserKitWidget.open(dialog);

If the dialog you are attempting to open requires a login, the user will be prompted to login first.

Page ID

Description

Login Required?

change_password

Provides a form allowing users to change their current password

Yes

forgot_password

Prompts the user to enter the identifier used to login. They will receive an email with instructions to reset their password.

No

login

Login form

No

register

User registration form

No

settings

Displays a form with the options for the current user to manage their user information

Yes

request_phone_verification_code

Used to validate phone numbers and change how a user logs in

No

Close all open dialogs

UserKitWidget.dismiss();

Logout current user

UserKit.logout();

Get current user data

UserKit.getUser();

Check if user is currently logged in

UserKit.isLoggedIn();