Skip to content
This repository has been archived by the owner on Nov 30, 2021. It is now read-only.

boundstate/angular-auth

Repository files navigation

Angular Auth

AngularJS authorization for ui-router.

Build Status

Installation

bower install boundstate-angular-auth

Include angular-auth.js and the libraries it depends on in your HTML:

<script src="bower_components/angular-local-storage/dist/angular-local-storage.js"></script>
<script src="bower_components/angular-ui-router/release/angular-ui-router.js"></script>
<script src="bower_components/angular-auth/angular-auth.js"></script>

Then load the module in your application by adding it as a dependent module:

angular.module('app', ['boundstate.auth']);

Usage

Configure authorization of your app states by setting the allowed roles for each state:

$stateProvider.state('app.account', {
  url: '/account',
  controller: 'AccountCtrl',
  templateUrl: 'partials/account.html',
  data: {
    // Allow authenticated users
    roles: ['@']
  }
})

There are three special roles:

  • *: any user, including both anonymous and authenticated users.
  • ?: anonymous users.
  • @: authenticated users.

Custom roles (e.g. admin) can be specified and will match against the authenticated user's roles property.

Initialize the auth service at run so that it can handle state changes:

.run(['auth', function(auth) {
  auth.initialize();
}]);

Once your app authenticates a user, provide the user object and token to the auth service:

auth.login(token, user);

The token and user object will be stored in local storage so they can be reloaded on a page refresh.

The token will be automatically passed in all subsequent requests according to the OAuth Bearer Token specifications.

When a user logs out, simply call logout():

auth.logout();

Inspiration

About

AngularJS authorization for ui-router

Resources

Stars

Watchers

Forks

Packages

No packages published