@okta/okta-auth-js

What is @okta/okta-auth-js?

@okta/okta-auth-js is a JavaScript library that provides a set of tools for integrating Okta's authentication and authorization services into your web applications. It allows you to handle user authentication, manage tokens, and interact with Okta's APIs.

What are @okta/okta-auth-js's main functionalities?

User Authentication

This feature allows you to authenticate users by their username and password. The code sample demonstrates how to sign in a user and handle the authentication transaction.

const OktaAuth = require('@okta/okta-auth-js');
const authClient = new OktaAuth({
  issuer: 'https://{yourOktaDomain}/oauth2/default',
  clientId: '{clientId}',
  redirectUri: 'http://localhost:8080/login/callback'
});

async function signIn(username, password) {
  try {
    const transaction = await authClient.signIn({ username, password });
    if (transaction.status === 'SUCCESS') {
      authClient.token.getWithRedirect({
        sessionToken: transaction.sessionToken
      });
    } else {
      throw new Error('We cannot handle the ' + transaction.status + ' status');
    }
  } catch (err) {
    console.error(err);
  }
}

Token Management

This feature allows you to manage tokens, including obtaining tokens without prompting the user. The code sample demonstrates how to get an ID token using the OktaAuth client.

const OktaAuth = require('@okta/okta-auth-js');
const authClient = new OktaAuth({
  issuer: 'https://{yourOktaDomain}/oauth2/default',
  clientId: '{clientId}',
  redirectUri: 'http://localhost:8080/login/callback'
});

async function getToken() {
  try {
    const token = await authClient.token.getWithoutPrompt({
      responseType: 'id_token',
      scopes: ['openid', 'profile', 'email']
    });
    console.log(token);
  } catch (err) {
    console.error(err);
  }
}

Session Management

This feature allows you to manage user sessions. The code sample demonstrates how to check the current session using the OktaAuth client.

const OktaAuth = require('@okta/okta-auth-js');
const authClient = new OktaAuth({
  issuer: 'https://{yourOktaDomain}/oauth2/default',
  clientId: '{clientId}',
  redirectUri: 'http://localhost:8080/login/callback'
});

async function checkSession() {
  try {
    const session = await authClient.session.get();
    console.log(session);
  } catch (err) {
    console.error(err);
  }
}

Other packages similar to @okta/okta-auth-js

auth0-js

Auth0.js is a JavaScript library for integrating Auth0's authentication and authorization services into your web applications. It provides similar functionalities to @okta/okta-auth-js, such as user authentication, token management, and session handling. However, it is designed to work with Auth0's platform instead of Okta.

firebase-auth

Firebase Authentication is a service provided by Google Firebase that offers backend services, easy-to-use SDKs, and ready-made UI libraries to authenticate users to your app. It supports various authentication methods, including email/password, phone number, and social providers like Google, Facebook, and Twitter. While it provides similar functionalities to @okta/okta-auth-js, it is part of the larger Firebase ecosystem.

passport

Passport is a popular authentication middleware for Node.js. It provides a comprehensive set of strategies for authenticating with different services, including local username/password, OAuth, and OpenID Connect. While it offers similar functionalities to @okta/okta-auth-js, it is more flexible and can be used with various authentication providers.

README

Okta Auth JS

Okta Auth JS is a wrapper around Okta's authentication API. It can be used to get an Okta session cookie or an ID token.

If you want to use the SDK, see the instructions on the Okta Auth SDK developer page.

If you wish to contribute to okta-auth-js, please read the following contributing guidelines

If you want to modify the SDK, use the following instructions.

Building the SDK

1. Clone the SDK repo.

   [path]$ git clone [e-mail]:okta/okta-auth-js.git
   

2. Navigate to the new okta-auth-js folder, and install the Okta node dependencies.

   [path/okta-auth-js]$ npm install
   

3. Build the SDK. The output will be under dist/browser/. The standalone version is OktaAuthReqwest.min.js.

   [path/okta-auth-js]$ npm run build
   

Build and test commands

Command	Description
npm run build	Build the SDK
npm test	Run unit tests
npm run lint:report	Run linting tests