Skip to main content

Sign in Screen


Use Sign in Screen to let anonymous users sign in with email and password or a supported social provider.


Sign in screen with social sign-in options, email and password inputs, and account access links

This screen includes:

#ElementDescription
1HeaderDisplays Sign in title and close control
2BrandingDisplays Air Doctor logo
3Social sign-in optionsProvides Google, Apple, and Facebook authentication
4Email fieldRequired input for account email
5Password fieldRequired input with visibility toggle
6Sign in buttonSubmits credentials
7Forgot password linkOpens the reset password flow
8Create account linkOpens account registration
9User ID labelDisplays user identifier with copy action

Workflow

  1. Open the Sign in screen.
  2. Select a social sign-in option, or enter email and password.
  3. Select Sign in.
  4. Continue to the requested screen after successful authentication.

Validations

ScenarioApp behaviorSDK output
Email missingBlock sign-invalidation = email_required
Email invalidDisplay email validation statevalidation = invalid_email
Password missingBlock sign-invalidation = password_required
Credentials invalidDisplay sign-in errorerror = invalid_credentials
MFA requiredDisplay MFA verification modalmfa = required
Sign-in succeedsAuthenticate userstate = authenticated
Request rejectedDisplay error statestatus = 405

Actions

ScenarioApp behaviorSDK output
Sign-in screen opensLoad sign-in screenPUT /api/v3/sign-in
Email updatedUpdate email input stateemail = updated
Password updatedUpdate password input statepassword = updated
Password visibility selectedToggle password visibilitypasswordVisible = true/false
Sign in selectedSubmit email and passwordPOST /api/v3/sign-in
Social sign-in selectedSubmit social identity tokenPOST /api/v3/sign-in/social
Reset password selectedOpen reset password flownavigation = reset_password
Create account selectedOpen registration flownavigation = create_account
User ID copy selectedCopy user IDuserId = copied
Close selectedClose the modalstate = dismissed

Endpoint Resources

Sign In Screen

PUT 

v3/account/sign-in

Returns the sign-in screen for anonymous users.

Query Parameters

NameTypeRequiredDescription
screen-modestringYesControls which sign-in experience to render.

Sign In

POST 

v3/account/sign-in

Authenticates the user with email and password.

Query Parameters

NameTypeRequiredDescription
screen-modestringYesControls which sign-in experience to render.
emailstringYesAccount email address.
passwordstringYesAccount password.

Social Sign In

POST 

v3/account/sign-in/social

Authenticates the user with a social identity token.

Query Parameters

NameTypeRequiredDescription
screen-modestringYesControls which sign-in experience to render.
tokenstringYesFirebase identity token from the social provider.