@passageidentity/passage-js
Version:
Passage Complete for Web - Build a full custom passwordless authentication experience in any modern web app with Passage by 1Password.
99 lines (61 loc) ā¢ 4.3 kB
Markdown
## About
[Passage by 1Password](https://1password.com/product/passage) unlocks the passwordless future with a simpler, more secure passkey authentication experience. Passage handles the complexities of the [WebAuthn API](https://blog.1password.com/what-is-webauthn/), and allows you to implement passkeys with ease.
Use [Passkey Flex](https://docs.passage.id/flex) to add passkeys to an existing authentication experience.
Use [Passkey Complete](https://docs.passage.id/complete) as a standalone passwordless auth solution.
Use [Passkey Ready](https://docs.passage.id/passkey-ready) to determine if your users are ready for passkeys.
### In passage-js
Passage-JS provides a convenient JavaScript interface to handling all client-side operations for user authentication and management with Passkey Complete. If you're looking for a pre-built UI that handles everything for you elegantly check out our UI library [passage-elements](https://www.npmjs.com/package/@passageidentity/passage-elements) or [passage-react](https://www.npmjs.com/package/@passageidentity/passage-react).
What's Included?
š Getting and editing information about the currently authenticated user.
š¤ Managing the session of the current user.
š Full passkey authentication.
āØ Magic Link and One-Time Passcodes over email or SMS.
š„ Authentication with Social providers.
šŖ Custom token management.
| Product | Compatible |
| --- | --- |
|  Passkey **Flex** | āļø For Passkey Flex, check out [passage-flex-js](https://www.npmjs.com/package/@passageidentity/passage-flex-js)
|  Passkey **Complete** | ā
|  Passkey **Ready** | āļø For Passkey Ready, check out [Authentikit](https://www.npmjs.com/package/@passageidentity/authentikit)
<br />
## Getting Started
### Check Prerequisites
<p>
You'll need a free Passage account and a Passkey Complete app set up in <a href="https://console.passage.id/">Passage Console</a> to get started. <br />
<sub><a href="https://docs.passage.id/home#passage-console">Learn more about Passage Console ā</a></sub>
</p>
### Install
```shell
npm i @passageidentity/passage-js
```
### Import
```js
import { Passage } from '@passageidentity/passage-js'
```
### Initialize
```js
const passage = new Passage('YOUR_PASSAGE_APP_ID');
```
### Go Passwordless
Find aditional customization options and more implementation guidance on our [Passkey JS Documentation](https://docs.passage.id/complete/passage-js) page.
## Support & Feedback
We are here to help! Find additional docs, the best ways to get in touch with our team, and more within our [support resources](https://github.com/passageidentity/.github/blob/main/SUPPORT.md).
<br />
---
<p align="center">
<picture>
<source media="(prefers-color-scheme: dark)" srcset="https://storage.googleapis.com/passage-docs/github-md-assets/passage-by-1password-dark.png">
<source media="(prefers-color-scheme: light)" srcset="https://storage.googleapis.com/passage-docs/github-md-assets/passage-by-1password-light.png">
<img alt="Passage by 1Password Logo" src="https://storage.googleapis.com/passage-docs/github-md-assets/passage-by-1password-light.png">
</picture>
</p>
<p align="center">
<sub>Passage is a product by <a href="https://1password.com/product/passage">1Password</a>, the global leader in access management solutions with nearly 150k business customers.</sub><br />
<sub>This project is licensed under the MIT license. See the <a href="LICENSE">LICENSE</a> file for more info.</sub>
</p>
# API Reference