Identity

- manages users
- registers
- authorizes
- autenticates
- distributes tokens

-----------------

API

Classes

AuthService

Authorizator

UsersService

UserAccessor

Functions

aclResolver(aclObject, [groupTree], [glue]) ⇒ Map.<string, Set.<string>>

Typedefs

Group : Object

AuthService

Kind: global class

* AuthService
* [new AuthService(getUserByIdFn, [tokenStorage], [options], [appsProvider])](#new_AuthService_new)
* .expressMiddleware() ⇒ function
* .createUserToken(userId, domain) ⇒ Promise.<Object>
* .createPasswordResetToken(userId) ⇒ Promise
* .getAndRemovePasswordResetToken(token) ⇒ Promise.<(Object\|null)>
* [.createToken(type, [userIdOrGroups], [options], [length])](#AuthService+createToken) ⇒ Promise
* .getToken(type, token) ⇒ Promise.<(Object\|null)>
* .dropToken(token) ⇒ Promise
* [.createUserAccessor([userGroups], [userId])](#AuthService+createUserAccessor) ⇒ UserAccessor

$3

Creates an instance of AuthService

| Param | Type | Default |
| --- | --- | --- |
| getUserByIdFn | function | |
| [tokenStorage] | TokenStorage | |
| [options] | Object | {} |
| options.acl | Object | |
| options.groups | Object | |
| options.tokenFactory | function | |
| [options.passwordReset] | Object | |
| [options.passwordReset.tokenExpiresInMinutes] | number | |
| options.superGroup | string | |
| options.adminGroups | Array.<string> | |
| [options.cookieKey] | string | |
| [options.signed] | boolean | |
| [options.tokenType] | string | |
| [appsProvider] | Map.<string, (Object\|Promise.<Object>)> | new Map() |

$3

Kind: instance method of AuthService

$3

Kind: instance method of AuthService

| Param | Default |
| --- | --- |
| userId | |
| domain | |

$3

Kind: instance method of AuthService

| Param | Type |
| --- | --- |
| userId | string |

$3

Kind: instance method of AuthService

| Param | Type |
| --- | --- |
| token | string |

$3

Kind: instance method of AuthService

| Param | Type | Default |
| --- | --- | --- |
| type | string | |
| [userIdOrGroups] | string | null |
| [options] | Object | |
| [length] | number | |

$3

Kind: instance method of AuthService

| Param | Type |
| --- | --- |
| type | string |
| token | string |

$3

Kind: instance method of AuthService

| Param | Type |
| --- | --- |
| token | string |

$3

Kind: instance method of AuthService

| Param | Type | Default |
| --- | --- | --- |
| [userGroups] | Array.<Group> | [] |
| [userId] | string | null |

Authorizator

Kind: global class

$3

Creates an instance of Authorizator.

| Param | Type |
| --- | --- |
| aclList | Map.<String, Set.<String>> |
| [superGroup] | string |

UsersService

Kind: global class

* UsersService
* [new UsersService(userStorage, [config], [formatter])](#new_UsersService_new)
* .storage : MongoDbUserStorage

$3

| Param | Type | Description |
| --- | --- | --- |
| userStorage | \* | |
| [config] | Object | |
| [config.superGroup] | string | |
| [config.adminGroups] | Array.<string> | |
| [formatter] | function | user formatter |

$3

Kind: instance property of UsersService

UserAccessor

Kind: global class

* UserAccessor
* [new UserAccessor(userGroups, [byUserId], [superGroup], [adminGroups])](#new_UserAccessor_new)
* [.setUser([userGroups], [byUserId])](#UserAccessor+setUser)
* [.isMe([userId])](#UserAccessor+isMe) ⇒ boolean
* .isRelated(groups) ⇒ boolean
* .isAdministrable(groups) ⇒ boolean
* [.filterGroups(groupList, personId, [justManageable])](#UserAccessor+filterGroups) ⇒ Array.<Group>

$3

| Param | Type | Default |
| --- | --- | --- |
| userGroups | Array.<Group> | |
| [byUserId] | string | null |
| [superGroup] | string | null |
| [adminGroups] | Array.<string> | |

$3

Kind: instance method of UserAccessor

| Param | Type | Default |
| --- | --- | --- |
| [userGroups] | Array.<Group> | |
| [byUserId] | string | null |

$3

Kind: instance method of UserAccessor

| Param | Type |
| --- | --- |
| [userId] | string |

$3

Kind: instance method of UserAccessor

| Param | Type |
| --- | --- |
| groups | Array.<Group> |

$3

Kind: instance method of UserAccessor

| Param | Type |
| --- | --- |
| groups | Array.<Group> |

$3

Kind: instance method of UserAccessor

| Param | Type | Default |
| --- | --- | --- |
| groupList | Array.<Group> | |
| personId | string | |
| [justManageable] | boolean | false |

aclResolver(aclObject, [groupTree], [glue]) ⇒ Map.<string, Set.<string>>

Kind: global function

| Param | Type | Default |
| --- | --- | --- |
| aclObject | any | |
| [groupTree] | any | |
| [glue] | string | "'.'" |

Group : Object

Kind: global typedef
Properties

| Name | Type |
| --- | --- |
| group | string |
| domain | string |