Class Embedded

Hierarchy

  • Embedded

Constructors

constructor

Properties

core

Methods

authenticate authenticateOtp bindPasskey deletePasskey getAuthenticationContext getPasskeys isAuthenticateUrl isBindPasskeyUrl redeemOtp initialize

Constructors

Private constructor

Properties

Private core

core: Core

Methods

authenticate

  • Authenticates against the specified passkey bound to the browser.

    Parameters

    • url: string

      The authentication URL of the current transaction.

    • passkeyId: string

      The ID of the passkey to authenticate with.

    Returns Promise<AuthenticateResponse>

    A promise that resolves to an AuthenticateResponse containing a redirect URL and a message.

    Throws

    Will throw an error if the operation fails.

authenticateOtp

  • Initiates authentication using an OTP, which will be sent to the provided email address.

    Parameters

    • url: string

      The authentication URL of the current transaction.

    • email: string

      The email address where the OTP will be sent.

    Returns Promise<OtpChallengeResponse>

    A promise that resolves to an OtpChallengeResponse containing a URL with the state of the authentication.

    Throws

    Will throw an error if the operation fails.

bindPasskey

  • Binds a passkey to this browser.

    Parameters

    • url: string

      The URL to bind a passkey. This can either be a passkey binding link generated from a call to the Beyond Identity API or a passkey binding instruction from an email/sms.

    Returns Promise<BindPasskeyResponse>

    A promise that resolves to a BindPasskeyResponse containing the bound passkey and the post-binding redirect URI.

    Throws

    Will throw an error if the operation fails.

deletePasskey

  • Deletes a passkey from this browser.

    Parameters

    • id: string

      The ID of the passkey to be deleted.

    Returns Promise<void>

    A promise that resolves when the passkey is successfully deleted.

    Throws

    Will throw an error if the operation fails.

getAuthenticationContext

  • Returns the Authentication Context for the current transaction. The Authentication Context contains the Authenticator Config, Authentication Method Configuration, request origin, and the authenticating application.

    Parameters

    • url: string

      The authentication URL of the current transaction.

    Returns Promise<AuthenticationContext>

    A promise that resolves to the Authentication Context.

getPasskeys

  • Returns a list of all passkeys bound to this browser.

    Returns Promise<Passkey[]>

    A promise that resolves to a list of all passkeys bound to this browser.

    Throws

    Will throw an error if the operation fails.

isAuthenticateUrl

  • Checks if the given URL is an authenticate URL.

    Parameters

    • url: string

      The URL to be checked.

    Returns boolean

    Returns true if the URL is an authenticate URL, otherwise false.

    Throws

    Will throw an error if the operation fails.

isBindPasskeyUrl

  • Checks if the given URL is a bind passkey URL.

    Parameters

    • url: string

      The URL to be checked. This can either be a passkey binding link generated from a call to the Beyond Identity API or a passkey binding instruction from an email/sms.

    Returns boolean

    Returns true if the URL is a bind passkey URL, otherwise false.

    Throws

    Will throw an error if the operation fails.

redeemOtp

Static initialize

  • Initializes the Embedded SDK. This function must be called before any other function.

    Parameters

    • Optional config: Config

      The optional configuration for the Embedded SDK.

    Returns Promise<Embedded>

    A promise that resolves to an instance of the Embedded SDK.

    Throws

    Will throw an error if the operation fails.

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc