@passageidentity/authentikit
v1.1.0
Published
A library for evaluating the passkey readiness of a user's browser.
Downloads
83
Maintainers
Keywords
Readme
About
Authentikit evaluates the passkey readiness of a user's browser. Results gathered by this tool can be viewed at the Passkey Ready page in Passage Console. This function will use a combination of browser-defined WebAuthn utility functions and the user-agent to determine what passkey features are supported by the browser and post the results to Passage. This function will only post results to Passage once every 24 hours.
Getting Started
Install this package using npm.
npm i --save @passageidentity/authentikit
Prerequisite
Client side key for your Passage organization. This can be found on the organization settings page of Passage Console.
Usage
To retrieve data, call authentikit.passkey.evaluateReadiness()
upon page load.
Single-page apps
For single-page apps built with tools like React, Vue, or Angular we recommend placing this code near the main app constructor or function to ensure that it executes on all pages.
- Import the
Authentikit
class and construct anAuthentikit
object using the client side key. - Make a call to
authentikit.passkey.evaluateReadiness()
on the page load of your main app body.
React Example
import { useEffect } from 'react';
import { Authentikit } from '@passageidentity/authentikit'
function App() {
useEffect(() => {
const authentikit = new Authentikit({clientSideKey: clientSideKey});
authentikit.passkey.evaluateReadiness();
},[]);
return (
// Main app body
);
}
export default App;