Salte Auth

OAuth 2.0 for the masses!

Supported Browsers

If a version isn't specified that means we test on the latest and greatest, however most versions of that browser should work.

• Chrome
• Firefox
• Safari 7+ (7.1 and below require a Promise polyfill)
• Edge
• IE 10+ (Requires a Promise polyfill)

Promise Polyfill

Here's a list of well known ES6 Promise implementations developed by the community!

• es6-promise
• native-promise-only
• bluebird

Any other ES6 Promise implementation will work as well!

Install

You can install this package either with npm or with bower.

npm

$ npm install @salte-io/salte-auth

Then add a <script> to your index.html:

<script src="/node_modules/@salte-io/dist/salte-auth.js"></script>

Or require('@salte-io/salte-auth') from your code.

bower

$ bower install salte-io/salte-auth

Then add a <script> to your index.html:

<script src="/bower_components/salte-auth/dist/salte-auth.js"></script>

HTML Imports (Polymer 1.x - 2.x)

We also support HTML Imports:

<link rel="import" href="/bower_components/salte-auth/salte-auth.html">

Usage

import { SalteAuth } from '@salte-io/salte-auth';

// Configure SalteAuth with Auth0's url and client id.
const auth = new SalteAuth({
  providerUrl: 'https://salte-alpha.auth0.com',
  responseType: 'id_token',
  redirectUrl: location.origin,
  clientId: 'mM6h2LHJikwdbkvdoiyE8kHhL7gcV8Wb',
  scope: 'openid',

  routes: [
    'http://localhost:8080/account'
  ],

  endpoints: [
    'https://jsonplaceholder.typicode.com/posts/1'
  ],

  provider: 'auth0'
});

// Display an iframe to the user that allows them to login
auth.loginWithIframe();

Known Issues

These are issues that we know about, but don't have a clear fix for!

There are currently no known issues, thanks for checking!

Debugging

Debug logging can be enabled by setting a localStorage variable of debug to @salte-io/salte-auth*.

Documentation

Click here to view the documentation!

Use private or undocumented methods at your own risk, as they will not require a major version bump when breaking changes are made!