Share your code. npm Orgs help your team discover, share, and reuse code. Create a free org »

mongoose-oauth-store-multi-tenant

2.0.1 • Public • Published

Build Status Coverage Status NPM Version Dependency Status NPM Downloads Issues API Documentation

WARNING - THIS WILL BE REFACTORED (AUG 2014) - USE AT YOUR OWN RISK FOR NOW.

mongoose-oauth-store-multi-tenant

A bunch of mongoose schemas to implement identity management (accesstokens, oauth apps) in multi tenant scenarios.

Key Concepts

  • Each document in the database has a _tenantId. This _tenantId (formerly accountId) can be a fixed ObjectId in single tenant scenarios.

  • You should not have to work with the schemas directly, instead we expose methods that encapsulate the most common use cases.

Getting started

mongooseOauthStoreMultiTenant = require 'mongoose-oauth-store-multi-tenant'
 
oauthProvider = 
      "authorizeUrl": "/oauth/authorize"
      "accessTokenUrl": "/oauth/token"
      "scopes": [
        {"name": "read""description": "Allows read access to your data.""developerDescription": """roles": ["public"]},
        {"name": "write""description": "Allows write access to your data.""developerDescription": """roles": ["public"]},
        {"name": "email""description": "Allows access to your email address.""developerDescription": """roles": ["public"]},
        {"name": "admin""description": "Allows full admin access to the platform.""developerDescription": """roles": ["admin"]}
      ]
 
 
oauthStore = mongooseOauthStoreMultiTenant.store 
                        oauthProvider : oauthProvider
                        autoIndex : true # True for debug / false for production 
 

Accessing functionality

 
oauthStore.oauthAuth. ...
oauthStore.oauthScopes. ...
oauthStore.oauthApps. ...
oauthStore.admin. ...
 

See also

and additionally

Contributing to mongoose-oauth-store-multi-tenant

  • Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet
  • Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it
  • Fork the project
  • Start a feature/bugfix branch
  • Commit and push until you are happy with your contribution
  • Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
  • Please try not to mess with the package.json, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.

Copyright

Copyright (c) 2012 - 2014 Martin Wawrusch See LICENSE for further details.

install

npm i mongoose-oauth-store-multi-tenant

Downloadsweekly downloads

11

version

2.0.1

license

MIT

homepage

github.com

repository

Gitgithub

last publish

collaborators

  • avatar