Auth SDK Reference Documenation

The Auth SDK is designed to make interacting with the Broadleaf Authorization Server easier from various JS frontend applications.

Table of Contents

Overview
Installation
Next steps

Overview

This SDK contains two packages: @broadleaf/auth-web for use with generic JavaScript web apps and @broadleaf/auth-react with additional utility for React web apps.

Installation

Important

If you add @broadleaf/auth-react you will not need to also add @broadleaf/auth-web.

Using the package manager of your choice, run the following command inside your project directory to add the basic JS SDK:

npm install @broadleaf/auth-web
# or
yarn add @broadleaf/auth-web

Next steps

Using the nav on the left, explore the specific implementation details of each module.