2.0.2 • Published 9 years ago

kazana-account v2.0.2

Weekly downloads
5
License
Apache-2.0
Repository
github
Last release
9 years ago

kazana-account

Kazana core module for all things accounts and authentication

NPM version Build Status Coverage Status

Install

git clone git@github.com:eHealthAfrica/kazana-account.git
cd kazana-account
npm install

## Usage

The service uses CouchDB's authentication system behind the curtain, so every user needs a document in the _users database.

Special requirements:

  1. roles: must to contain at least on of the kazana-* roles, see below
  2. roles: must contain the user id, in the form: "kazana-id:<userId here>"
  3. createdAt: ISO timestamp for the time the user account has been created
  4. fullname: must contain the name of the user

An example _users doc for reference (without the password properties):

{
   "_id": "org.couchdb.user:gregor@martynus.net",
   "_rev": "3-16dd17eaf12eb656ea2d1882ee7018ad",
   "name": "gregor@martynus.net",
   "roles": [
       "kazana-id:abcdef",
       "kazana-admin"
   ],
   "type": "user",
   "createdAt": "2015-04-15T00:00:00.000Z",
   "fullname": "Gregor Martynus"
}

User Access Levels (roles)

Routes

GET /api/session
POST /api/session
DELETE /api/session

Test

Dependency Status devDependency Status

npm test

Credit

Brought to you by eHealth Africa — good tech for hard places.

License

Apache-2.0