retsly-js-auth v0.7.3
retsly-js-auth
A third party authentication and verification component built on Retsly
Demo
Installation
Install with npm:
$ npm install retsly-js-authUsage
The Retsly Auth Component requires a constructed instance of the Retsly SDK.
You should inject into the module as shown below:
var retsly = new Retsly(YOUR_CLIENT_ID, YOUR_JS_TOKEN);
var Auth = require('retsly-js-auth')(retsly);
new Auth({
selector: '.login', // Target Dom Element
redirect_uri: 'http://website.com/callback',
authorized: function(data) {
console.log('Authorized');
}
});The first time a user signs up they must pass activation and verification.
Your app should subscribe to all three events and wait until data.bundle indicates
that the user has an active status and has been verified.
Constructor Options
The object provided to new Auth() accepts the following options:
| Paramater | Value | Description |
|---|---|---|
| redirect_uri | string | Required The OAuth Redirect URI associated with your application. |
| authorized | function | Required The function called once the user has completed the Retsly OAuth Flow. |
| scope | string, space-separated | The scopes being requested by your app as a comma-separated string. If left undefined, defaults to 'user_profile'. |
| state | string | A unique string, reasonably unguessable, used to mitigate CSRF attacks. |
| vendors | string, space-separated | A custom list of one or more vendors the resultant flow will be tailored to |
| popop | boolean | Defines whether the OAuth flow will be initiated in a popup dialog or in the original window via redirect (Default: true) |
Response
The response from the OAuth flow is passed back to the authorized callback provided by the constructor. The response will either be an error object or an authorization object containing the token value, type, expiry information, and redirect_uri.
Repo Owner
License
(The MIT License)
Copyright (c) 2014 Retsly Software Inc support@rets.ly
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the 'Software'), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.