Skip to main content
Version: v1

isAuthenticateUrl

Last updated on

Validates that a URL is able to be used by the authenticate function.

Dependencies​

The isAuthenticateUrl function requires the Beyond Identity Javascript SDK.

npm install @beyondidentity/bi-sdk-js

Prerequisites​

Before making a call to isAuthenticateUrl, you must complete the following prerequisite calls:

  1. Import the required types and functions from the SDK
import {Embedded} from '@beyondidentity/bi-sdk-js';
  1. Initialize the SDK
const embedded = await Embedded.initialize();

Parameters​

ParameterTypeDescription
urlstringRequired. Url to be validated as Beyond Identity authentication url.

Returns​

Returns a boolean.

Examples​

Example: Authenticate only if the provided url is valid​

if (embedded.isAuthenticateUrl(url)) {
    // authenticate against a passkey bound to the device
}