JSDoc: Class: ACL

new ACL(connector)

Creates an instance of ACL. Examples: var neo4j = require('node-neo4j'); var graphACL = require('node-graph-acl'); var db = new neo4j('http://localhost:7474'); var connector = new graphACL.neo4jConnector(db); var acl = new graphACL(connector);

This:

{ACL}

Parameters:

Name	Type	Description
`connector`	Connector \| Neo4jConnector	A connector to a graph database of your choice

Source:

acl.js, line 22

Methods

_createRelationship(nodeId1, nodeId2, type, properties, callback)

Create Relationship. If relationship already exists, does nothing. Examples: acl._createRelationship(1, 2, 'TYPE', callback); acl._createRelationship(1, 2, 'TYPE', {p1:'v1', p2:'v2'}, callback);

Parameters:

Name	Type	Description
`nodeId1`	String \| Number	First Node ID.
`nodeId2`	String \| Number	Second Node ID.
`type`	String	Relationship type.
`properties`	Object	Relationship properties.
`callback`	function	Callback called when finished.

Source:

acl.js, line 679

_createResource(resourceId, callback)

Create Resource. If role already exists, does nothing. Examples: acl._createResource('resource1', callback);

Parameters:

Name	Type	Description
`resourceId`	String \| Number	Resource id.
`callback`	function	Callback called when finished.

Source:

acl.js, line 650

_createRole(roleId, callback)

Create Role. If role already exists, does nothing. Examples: acl._createRole('role1', callback);

Parameters:

Name	Type	Description
`roleId`	String \| Number	Role id.
`callback`	function	Callback called when finished.

Source:

acl.js, line 625

_createUser(userId, callback)

Create User. If user already exists, does nothing. Examples: acl._createUser('user1', callback);

Parameters:

Name	Type	Description
`userId`	String \| Number	User id.
`callback`	function	Callback called when finished.

Source:

acl.js, line 600

addRoleParents(role, parents, callback)

Add one or more parent roles to a role. Examples: acl.addRoleParents('role1', 'role2', callback); acl.addRoleParents('role1', ['role2', 'role3'], callback);

Parameters:

Name	Type	Description
`role`	String \| Number	Role id.
`parents`	String \| Array	Parent role(s) to add to the role.
`callback`	function	Callback called when finished.

Source:

acl.js, line 164

addUserRoles(userId, roles, callback)

Add roles to a given user. Examples: acl.addUserRoles('user1', 'role1', callback); acl.addUserRoles('user1', ['role1', 'role2'], callback);

Parameters:

Name	Type	Description
`userId`	String \| Number	User id.
`roles`	String \| Array	Role(s) to add to the user.
`callback`	function	Callback called when finished.

Source:

acl.js, line 37

allow(roles, resources, permissions, callback)

Add permissions to roles over resources.

Parameters:

Name	Type	Description
`roles`	String \| Array	Role(s) to add permission(s) of resource(s) to.
`resources`	String \| Array	Resource(s) to give permission(s) to.
`permissions`	String \| Array	Permission(s) of the resource(s).
`callback`	function	Callback called when finished.

Source:

acl.js, line 257

allowedPermissions(userId, resources, callback)

Get all the permissions the user has to over this resources. It returns an array of objects where every object maps a resource name to a list of permissions for that resource.

Parameters:

Name	Type	Description
`userId`	String \| Number	User.
`resources`	String \| Array	Resource(s) to ask permissions about.
`callback`	function	Callback called when finished.

Source:

acl.js, line 397

areAnyRolesAllowed(roles, resource, permissions, callback)

Check if the role(s) have permission(s) on the resource(s). Examples: acl.areAnyRolesAllowed('role1', 'resource1', 'permission1', callback); acl.areAnyRolesAllowed('role1', 'resource1', ['permission1', 'permission2'], callback); acl.areAnyRolesAllowed(['role1', role2], 'resource1', 'permission1', callback); acl.areAnyRolesAllowed(['role1', role2], 'resource1', ['permission1', 'permission2'], callback);

Parameters:

Name	Type	Description
`roles`	String \| Array	Role(s) ids to check the permissions for.
`resource`	String	Resource to ask permissions for.
`permissions`	String \| Array	Permission(s) over the resource.
`callback`	function	Callback called when finished.

Source:

acl.js, line 527

isAllowed(userId, resources, permissions, callback)

Check if a user is allowed to access resource(s) with given permission(s) (note: it must fulfil all the permissions). Examples: acl.isAllowed('user1', 'resource1', 'permission1', callback); acl.isAllowed('user1', ['resource1', 'resource2'], ['permission1', 'permission2'], callback);

Parameters:

Name	Type	Description
`userId`	String \| Number	User id.
`resources`	String \| Array	Resource(s) to ask permissions for.
`permissions`	String \| Array	Permission(s).
`callback`	function	Callback called when finished.

Source:

acl.js, line 479

removeAllow(role, resources, permissions, callback)

Remove permissions from roles over resources. Examples: acl.removeAllow('role1', 'resource1', 'permission1', callback); acl.removeAllow('role1', ['resource1', 'resource2'], ['permission1', 'permission2'], callback);

Parameters:

Name	Type	Description
`role`	String	Role to remove permission(s) of resource(s) from.
`resources`	String \| Array	Resource(s) to remove permission(s) from.
`permissions`	String \| Array	Permission(s) of the resource(s).
`callback`	function	Callback called when finished.

Source:

acl.js, line 333

removeResource(resourceId, callback)

Remove a resource from the system. Examples: acl.removeResource('resource1', callback);

Parameters:

Name	Type	Description
`resourceId`	String	Resource to be removed.
`callback`	function	Callback called when finished.

Source:

acl.js, line 559

removeRole(roleId, callback)

Remove a role from the system. Examples: acl.removeRole('role1', callback);

Parameters:

Name	Type	Description
`roleId`	String \| Number	Role to be removed
`callback`	function	Callback called when finished.

Source:

acl.js, line 200

removeUserRoles(userId, roles, callback)

Remove roles from a given user. Examples: acl.removeUserRoles('user1', 'role1', callback); acl.removeUserRoles('user1', ['role1', 'role2'], callback);

Parameters:

Name	Type	Description
`userId`	String \| Number	User id.
`roles`	String \| Array	Role(s) to remove from the user.
`callback`	function	Callback called when finished.

Source:

acl.js, line 84

userRoles(userId, callback)

Return all the roles the user belongs to. Examples: acl.userRoles('user1', callback);

Parameters:

Name	Type	Description
`userId`	String \| Number	User id.
`callback`	function	Callback called when finished.

Source:

acl.js, line 129

whatResources(roles, permissions, callback)

Get resources the role(s) has permission(s) over. Examples: acl.whatResources('role1', 'permission1', callback); acl.whatResources('role1', ['permission1', 'permission2'], callback); acl.whatResources(['role1', role2], 'permission1', callback); acl.whatResources(['role1', role2], ['permission1', 'permission2'], callback);

Parameters:

Name	Type	Description
`roles`	String \| Array	Roles ids.
`permissions`	String \| Array	Permissions ids.
`callback`	function	Callback called when finished.

Source:

acl.js, line 545