ng-auth

This module aims to help apps with OAuth2 authentication in angular apps.

Setup

1. bower install --save ng-auth
2. Make sure you have the file referenced in your index.html (i.e <script src="bower_components/ng-auth/dist/ng-auth.js"></script>)

Usage

First, make sure you include the module in your app.

angular.module('myModule', ['ng-auth']);

Configure your client with the following options on your config function:

• clientId ( required ) : Id of your client
• oauth2Url ( required ) : url to redirect to for authentication
• scope : ([string, string]) array of scope strings
• autoAuth : if true, the app will redirect to authenticate when it loads, if false you will have to manually call $oauth2.authenticate() at some point in your app with the $oauth2 service. Defaults to true.
• state : a string representing the state of your app you wish to return to. If you are using ngRoute you can set this value to true to use the angular path part of the route as your state, and you will return directly to where you started in your app after authentication.
• contentUrls : ([string, string]) an array of API prefixes that need to be protected by auth. The module will ensure that a valid token is possessed by the user before getting content from these API's and will even automatically refresh your token in the background when it expires. (If your OAuth2 Provider supports it)
• redirectUri ( required ) : the URL you want auth to take the user back to after authentication. If you just want to user to go back to where they started, set this as true
• options : a map of additional key/value pairs to include on the request to auth

Example

.config(['$oauth2Provider', function ($oauth2Provider) {
	$oauth2Provider.configure({
		clientId: '12345',
		redirectUri: true,
		state: true,
		oauth2Url: 'https://authy.domain.com/oauth2',
		scope: ['https://api.me.com/myapp', 'https://api.me.com/myotherapp']
	});
}]);

Optional Params

If you need to add custom params to the request to the OAuth2 server, just add them as a hash called options:

options: {
	request_auths: 'blah'
}

Pro Tips

If you want to run a function when a user actually authenticates to your app, you can do so. Using the $oauth2 service (likely in a $rootScope.run function), register your callback function like so:

$oauth2.registerCallback(function () {
	// Do something
});

Multiple modules can register with the auth client at once. Only one module should supply the required options in the configuration, but if other modules have their own .config() function, they too can supply configuration options to the auth module. This can be useful if you want to extrapolate away your backend code into its own module, and have it register the required scopes and content_urls with auth.