Angular authomator

Component to integrate with an Authomator backend:

• includes auth service with authentication logic
• includes session service to keep track of session data
• exposes auth and session on $rootScope
• includes code to check access during application bootstrap
• includes code to check access during route/state changes
• includes HTTP interceptor that redirects to login page when 401 response is received
• includes unit tests

Installation

First install the component:

$ ngx install angular-authomator

Then:

• edit app.config.authomator.js in the _build directory and supply your Authomator url.
• remove files you don't need e.g. if you don't need a state change listener, HTTP interceptor, etc.

No clue what the ngx command line tool is? Learn more about AngularJS Express.

Requirements

Make sure the angular-authomator module is loaded.

Auth service

auth.redirectToLoginPage()

Redirect to the Authomator login page. Helper function for auth.login() but can be called directly as well.

Arguments

none

Returns

void

Example

In script:

if(!auth.isLoggedIn()){
  return auth.redirectToLoginPage();
}

In markup:

<a ng-click="auth.redirectToLoginPage()">Log in</a>

auth.logIn()

Log in. Redirect to Authomator login page.

After logging in successfully on the Authomator login page, the session data will be available and auth.isLoggedIn() will return true.

Arguments

none

Returns

void

Example

In script:

if(!auth.isLoggedIn()){
  return auth.logIn();
}

In markup:

<a ng-click="auth.logIn()">Log in</a>

auth.logOut()

Log out. Log out user and destroy session data.

Arguments

none

Returns

void

Example

In script:

if(auth.isLoggedIn()){
  return auth.logOut();
}

In markup:

<a ng-click="auth.logOut()">Log out</a>

auth.isLoggedIn()

Checks whether user is logged in or not.

Arguments

none

Returns

Boolean

Example

In script:

if(!auth.isLoggedIn()){
  return auth.redirectToLoginPage();
}

In markup:

<h1 ng-if="auth.isLoggedIn()">Logged in!</h1>

Session service

session.getIdentity()

Get identity.

Arguments

none

Returns

Object: the entire identity as it was returned by Authomator, already decoded from the identity token.

Example

In script:

var identity = session.getIdentity();

In markup:

<pre ng-if="auth.isLoggedIn()">
  {{ session.getIdentity() | json }}
</pre>

session.getIdentityToken()

Get identity token.

Arguments

none

Returns

String: the identity token as it was provided by Authomator

Example

In script:

var token = session.getIdentityToken();

In markup:

<pre ng-if="auth.isLoggedIn()">
  {{ session.getIdentityToken() | json }}
</pre>

session.getAccessToken()

Get access token.

Arguments

none

Returns

String: the access token as it was provided by Authomator

Example

In script:

var token = session.getAccessToken();

In markup:

<pre ng-if="auth.isLoggedIn()">
  {{ session.getAccessToken() | json }}
</pre>

session.getRefreshToken()

Get refresh token.

Arguments

none

Returns

String: the refresh token as it was provided by Authomator

Example

In script:

var token = session.getRefreshToken();

In markup:

<pre ng-if="auth.isLoggedIn()">
  {{ session.getRefreshToken() | json }}
</pre>

session.destroy()

Remove all session data. Clears the identity and all tokens.

There usually is no need to call this method directly. Use auth.logOut(), which will call this method for you.

Arguments

none

Returns

String: the refresh token as it was provided by Authomator

Example

In script:

session.destroy();

In markup:

<a ng-click="session.destroy()">Destroy the session</a>

Change log

v1.0.0

• Used in production

v0.4.0

• Added HTTP interceptor

v0.3.0

• Added access control scripts

v0.2.0

• Added session service
• Added auth service

v0.1.0

• Initial version

License

MIT.