auth0-acul-js - v1.0.1

📚 Documentation - 🚀 Getting Started - 💻 API Reference - 💬 Feedback

📚 Documentation

• Docs Site - explore our docs site and learn more about Auth0
• FAQs - frequently asked questions about the auth0-acul-js SDK.

Architecture

🚀 Getting started

Prerequisites

• Ensure that a custom domain is configured for your tenant.
• Set up the required screen within the actual flow.
  • For more information, refer to the management API documentation (TBD).

Installation

From npm:

npm install @auth0/auth0-acul-js
Copy

After installing the SDK, you can import the relevant screen module, which you want to configure

Usage

// Default import of any particular screen, eg: login-id screen
import  LoginId  from '@auth0/auth0-acul-js/login-id'; 

// Named import of any screen
import  { LoginId }  from '@auth0/auth0-acul-js'; 

// Default import of all screens
import  Screens  from '@auth0/auth0-acul-js'; 

Copy

Please refer FAQ's for detailed info on import paths for all screen

Adding logic to your User Interface/Screens via SDK methods

Taking example of login-id screen

Adding functionality to login button

  import  LoginId  from '@auth0/auth0-acul-js/login-id';

  const loginIdManager = new LoginId();
  loginIdManager.login({
    username: <USERNAME_FIELD_VALUE>
  });
Copy

Getting list of manadtory fields to proceed with login

const { transaction } = loginIdManager
const requiredFields = transaction.getActiveIdentifiers();
Copy

Integrate social connections to login flow

If there is an assosiated social connection, below snippet can help login with selected social connection

import  LoginId  from "@auth0/auth0-acul-js/login-id";
const loginIdManager = new LoginId();

// Check if alternateConnections is available and has at least one item
if (!loginIdManager.transaction.hasAlternateConnections) {
  console.error('No alternate connections available.');
}

// Select the first available connection (users can select any available connection)
const selectedConnection = alternateConnections[0];

// Log the chosen connection for debugging or informational purposes
console.log(`Selected connection: ${selectedConnection.name}`);

// Proceed with federated login using the selected connection
loginIdManager.continueWithFederatedLogin({
  connection: selectedConnection.name,
})
Copy

See more examples

💻 API reference

Screens

1. login-id
2. login-Password
3. signup-id
4. signup-password

See more

5. login-passwordless-email-code
6. login-passwordless-sms-otp
7. passkey-enrollment
8. passkey-enrollment-local
9. phone-identifier-enrollment
10. phone-identifier-challenge
11. email-identifier-challenge
12. interstitial-captcha

💬 Feedback

Contributing

We appreciate feedback and contribution to this repo! Before you get started, please see the following:

• Auth0's general contribution guidelines
• Auth0's code of conduct guidelines

Raise an issue

To provide feedback or report a bug, please raise an issue on our issue tracker.

Vulnerability Reporting

Please do not report security vulnerabilities on the public GitHub issue tracker. The Responsible Disclosure Program details the procedure for disclosing security issues.

---

Auth0 is an easy to implement, adaptable authentication and authorization platform. To learn more checkout Why Auth0?

This project is licensed under the MIT license. See the LICENSE file for more info.