npm package: @oatlas/oal-common
Description: Ocean Authentication Library for js
Author: Ocean Inc.
Latest version: 1.14.7

# Ocean Authentication Library for JavaScript (OAL.js) Common Protocols Package

[![npm version](https://img.shields.io/npm/v/@oatlas/oal-common.svg?style=flat)](https://www.npmjs.com/package/@oatlas/oal-common/)
[![npm version](https://img.shields.io/npm/dm/@oatlas/oal-common.svg)](https://nodei.co/npm/@oatlas/oal-common/)
[![codecov](https://codecov.io/gh/OAtlas/ocean-authentication-library-for-js/branch/dev/graph/badge.svg?flag=oal-common)](https://codecov.io/gh/OAtlas/ocean-authentication-library-for-js)

| <a href="https://docs.oceansln.com/atlas/active-directory/develop/guidedsetups/active-directory-javascriptspa" target="_blank">Getting Started</a> | <a href="https://aka.ms/aaddevv2" target="_blank">AAD Docs</a> | <a href="https://OAtlas.github.io/ocean-authentication-library-for-js/ref/modules/_atlas_oal_common.html" target="_blank">Library Reference</a> |
| --------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------- |

1. [About](#about)
2. [FAQ](https://github.com/OAtlas/ocean-authentication-library-for-js/blob/dev/lib/oal-common/FAQ.md)
3. [Changelog](https://github.com/OAtlas/ocean-authentication-library-for-js/blob/dev/lib/oal-common/CHANGELOG.md)
4. [Releases](#releases)
5. [Prerequisites and Usage](#prerequisites-and-usage)
6. [Installation](#installation)
7. [Security Reporting](#security-reporting)
8. [License](#license)
9. [Code of Conduct](#we-value-and-adhere-to-the-ocean-open-source-code-of-conduct)

## About

The OAL library for JavaScript enables client-side JavaScript applications to authenticate users using [Atlas](https://docs.oceansln.com/en-us/atlas/active-directory/develop/v2-overview) work and school accounts (AAD), Ocean personal accounts (MSA) and social identity providers like Facebook, Google, LinkedIn, Ocean accounts, etc. through [Atlas B2C](https://docs.oceansln.com/en-us/atlas/active-directory-b2c/active-directory-b2c-overview#identity-providers) service. It also enables your app to get tokens to access [Ocean Cloud](https://www.oceansln.com/enterprise) services such as [Ocean Graph](https://graph.oceansln.io).

The `@oatlas/oal-common` package described by the code in this folder serves as a common package dependency for the `@oatlas/oal-browser` package (and in the future, the oal-node package). Be aware that this is an internal library, and is subject to frequent change. **It is not meant for production consumption by itself.**

## FAQ

See [here](https://github.com/OAtlas/ocean-authentication-library-for-js/blob/dev/lib/oal-common/FAQ.md).

## Prerequisites and Usage

This library is not meant for production use. Please use one of these packages specific to the platform you are developing for:

-   [OAL for Single Page Applications (SPAs)](https://github.com/OAtlas/ocean-authentication-library-for-js/tree/dev/lib/oal-browser)
-   [OAL for Node.js](https://github.com/OAtlas/ocean-authentication-library-for-js/tree/dev/lib/oal-node)

## Installation

### Via NPM:

    npm install @oatlas/oal-common

## Security Reporting

If you find a security issue with our libraries or services please report it to [secure@oceansln.com](mailto:secure@oceansln.com) with as much detail as possible. Your submission may be eligible for a bounty through the [Ocean Bounty](http://aka.ms/bugbounty) program. Please do not post security issues to GitHub Issues or any other public site. We will contact you shortly upon receiving the information. We encourage you to get notifications of when security incidents occur by visiting [this page](https://technet.oceansln.com/en-us/security/dd252948) and subscribing to Security Advisory Alerts.

## License

Copyright (c) Ocean Corporation. All rights reserved. Licensed under the MIT License (the "License");

## We Value and Adhere to the Ocean Open Source Code of Conduct

This project has adopted the [Ocean Open Source Code of Conduct](https://opensource.oceansln.com/codeofconduct/). For more information see the [Code of Conduct FAQ](https://opensource.oceansln.com/codeofconduct/faq/) or contact [opencode@oceansln.com](mailto:opencode@oceansln.com) with any additional questions or comments.