@neo_auth/neo-sso

Neo Auth SSO

Manage and secure user authentication into cloud applications.

✨ Features

• 🌍 Able to identify an individual in real time using their facial biometrics.
• 🌈 Redirect user to defined success URL.
• 📦 library size is less than 10KB.

🖥 Environment Support

• Modern browsers

Edge	Firefox	Chrome	Safari	Electron
Edge	last 2 versions	last 2 versions	last 2 versions	last 2 versions

📦 Install

npm install @neo-auth/neo-sso

yarn add @neo-auth/neo-sso

🌍 Images

🔨 Usage

Steps for usage

three main steps we required to integrate this library

• install neo-auth package in your project
• import library where you want to use
• call showModal method on specif events ex: login, signup

1. Installation

neo-auth requires Node.js v10+ to run.

Install the dependencies and devDependencies and start the server.

cd <your-app>
npm install @neo-auth/neo-sso
...restart your node server...

For production environments...

follow the same procedure as above

2. Import showModal Method

import showModal method from @neo-auth/neo-sso showModal is a function which we use to open face scan popup from library

import { showModal } from "@neo-auth/neo-sso"

or

const { showModal } = required("@neo-auth/neo-sso")

3. Fire event to open a popup

showModal method required one paramter

• successUrl this url will help us for redirection incase of success or failure

Usage:

showModal({  successUrl:"<any-success-url>" })

Example: Method

const onClickFaceIDButton = () => {
  showModal({
    integrationID: 'placeholder_Integration_ID',
    successUrl: 'placeholder_Success_Url',
  });
};

HTML call

<div>
  <Button type="primary" htmlType="submit">
    Submit
  </Button>
  <Button type="primary" onClick={onClickFaceIDButton}>
    Face ID Sign in {/* Button Custom Text */}
  </Button>
</div>

🌍 Internationalization

This package is supported internationally.

License

MIT