ICC Wrapped Auth

The icc-wrapped-auth library provides a class, ICCWrappedAuth, that provides a set of utilities for managing ICC tokens and authentication for the icc wrapped application. It facilitates secure communication between the main ICC applications and the ICC Wrapped application by handling user authentication tokens. It exposes methods to encrypt users access token, decrypt the access token, and revoke the users access token.

Installation

To install the package, run the following command in your project directory:

npm i @insomnia-labs/icc-wrapped-auth

Usage

Initializing the Authentication Class

Import the ICCWrappedAuth class from the package and initialize it with the desired environment.

import { ICCWrappedAuth } from "icc-wrapped-auth";

// Initialize with production environment
const auth = new ICCWrappedAuth("production");

or

// Initialize with staging environment
const auth = new ICCWrappedAuth("staging");

Encrypting a Token

Use the encryptToken method to encrypt a user's volt token. This token can then be included in URLs for redirecting users to the ICC wrapped application.

async function encryptUserToken() {
  const encryptedToken = await auth.encryptToken({
    token: "userVoltTokenHere",
    name: "Samuel Olamide",
    email: "[email protected]",
  });

  console.log("Encrypted Token:", encryptedToken);
}
encryptUserToken();

The encrypted token can then be passed to ICC Wrapped website like this as a query parameter recapped_access .

https://example.com?recapped_access={encryptedToken}

Validating an Encrypted Token

After encrypting a token, use validateToken to validate the encrypted token and optionally create a user instance on the application.

async function validateUserToken(encryptedToken) {
  const accessToken = await auth.validateToken(encryptedToken);

  console.log("Access Token:", accessToken);
}

Revoking an Access Token

To log a user out and invalidate their session, use the revokeAccessToken method.

async function revokeUserAccessToken(token) {
  const response = await auth.revokeAccessToken(token);

  console.log("Revoke Response:", response); // { statusCode: 200, message: 'Logged out successfully.' }
}

Support

For issues or feature requests, please reach out to the insomnia team.