Skip to main content

AuthResult

@loginid/websdk3Docs


@loginid/websdk3 / Internal Modules / AuthResult

Interface: AuthResult

The result after a successful authentication process either with passkeys or OTP.

Properties

deviceID?

optional deviceID: string

An identifier for the device used in the authentication process. This property helps determine if supported authentications can be proceeded, allowing future authentications to identify the device correctly.


fallbackOptions?

optional fallbackOptions: FallbackOptions

This property will be returned if the LoginID indicates that the user is unlikely to proceed with passkey authentication. In this case, instead of prompting for passkey authentication, available cross-authentication options are listed as an alternative, providing suggested authentications to use instead.


isAuthenticated

isAuthenticated: boolean

Indicates whether the user is authenticated. If false, a fallback options can be taken place if available on fallbackOptions.


isFallback

isFallback: boolean

If true, the authentication process should resort to a fallback method as specified in fallbackOptions.


token

token: string

A short-lived authorization token is returned, allowing access to protected resources for the given user such as listing, renaming or deleting passkeys.