Class: RBAC

Members

optionsObject

The RBAC's options.

storageStorage

The RBAC's storage.

Methods

staticRBAC.getPermissionNames(permissions){Array}

RBAC.js, line 813

Convert Array of permissions to permission name

Name	Type	Description
permissions	Array	List of array items of permission names. It contan action and resource

Returns:

of permission names

add(item, cb){RBAC}

RBAC.js, line 80

Register role or permission to actual RBAC instance

Name	Type	Description
item	Role | Permission	Instance of Base
cb	function	Callback function

Returns:

actual instance

can(roleName, action, resource, cb){RBAC}

RBAC.js, line 627

Return true if role has allowed permission

Name	Type	Description
roleName	String	Name of role
action	String	Name of action
resource	String	Name of resource
cb	function	Callback function

Returns:

instance

canAll(roleName, permissions, cb){RBAC}

RBAC.js, line 698

Check if the model has all of the given permissions.

Name	Type	Description
roleName	String	Name of role
permissions	Array	Array (String action, String resource)
cb	function	Callback function

Returns:

instance

canAny(roleName, permissions, cb){RBAC}

RBAC.js, line 661

Check if the role has any of the given permissions.

Name	Type	Description
roleName	String	Name of role
permissions	Array	Array (String action, String resource)
cb	function	Callback function

Returns:

instance

create(roleNames, permissionNames, grants, cb){RBAC}

RBAC.js, line 529

Create multiple permissions and roles in one step

Name	Type	Description
roleNames	Array	List of role names
permissionNames	Object	List of permission names
grants	Object	optional List of grants
cb	Array	Callback function

Returns:

of actual RBAC

createPermission(action, resource, add, cb){Permission}

RBAC.js, line 294

Create a new permission assigned to actual instance of RBAC

Name	Type	Default	Description
action	String		Name of action
resource	String		Name of resource
add	Boolean	true	optional True if you need to add it to the storage
cb	function		Callback function

Returns:

of the Permission

createPermissions(permissions, add, cb){RBAC}

RBAC.js, line 431

Create multiple permissions in one step

Name	Type	Default	Description
permissions	Object		Object of permissions
add	Boolean	true	optional True if you need to add it to the storage
cb	function		Callbck function

Returns:

of actual RBAC

createRole(roleName, add){Role}

RBAC.js, line 280

Create a new role assigned to actual instance of RBAC

Name	Type	Default	Description
roleName	String		Name of new Role
add	Boolean	true	optional True if you need to add it to the storage

Returns:

of the Role

createRoles(roleNames, add, cb){RBAC}

RBAC.js, line 468

Create multiple roles in one step assigned to actual instance of RBAC

Name	Type	Default	Description
roleNames	Array		Array of role names
add	Boolean	true	optional True if you need to add it to the storage
cb	function		Callback function

Returns:

instance

exists(name, cb){RBAC}

RBAC.js, line 310

Callback returns true if role or permission exists

Name	Type	Description
name	String	Name of item
cb	function	Callback function

Returns:

instance of actual RBAC

existsPermission(action, resource, cb){RBAC}

RBAC.js, line 340

Callback returns true if permission exists

Name	Type	Description
action	String	Name of action
resource	String	Name of resource
cb	function	Callback function

Returns:

instance of actual RBAC

existsRole(name, cb){RBAC}

RBAC.js, line 325

Callback returns true if role exists

Name	Type	Description
name	String	Name of item
cb	function	Callback function

Returns:

instance of actual RBAC

get(name, cb){RBAC}

RBAC.js, line 100

Get instance of Role or Permission by his name

Name	Type	Description
name	String	Name of item
cb	function	Callback function

Returns:

instance of actual RBAC

getPermission(name, cb){RBAC}

RBAC.js, line 401

Return instance of Permission by his name

Name	Type	Description
name	String	Name of permission
cb	function	Callback function

Returns:

instance of actual RBAC

getPermission(action, resource, cb){RBAC}

RBAC.js, line 385

Return instance of Permission by his action and resource

Name	Type	Description
action	String	Name of action
resource	String	Name of resource
cb	function	Callback function

Returns:

instance of actual RBAC

getPermissions(cb){RBAC}

RBAC.js, line 417

Return all instances of Permission

Name	Type	Description
cb	function	Callback function

Returns:

instance of actual RBAC

getRole(name, cb){RBAC}

RBAC.js, line 356

Return instance of Role by his name

Name	Type	Description
name	String	Name of role
cb	function	Callback function

Returns:

instance of actual RBAC

getRoles(cb){RBAC}

RBAC.js, line 371

Return all instances of Role

Name	Type	Description
cb	function	Callback function

Returns:

instance of actual RBAC

getScope(roleName, cb){RBAC}

RBAC.js, line 780

Return array of all permission assigned to role of RBAC

Name	Type	Description
roleName	String	Name of role
cb	function	Callback function

Returns:

instance

grant(role, child, cb){RBAC}

RBAC.js, line 164

Grant permission or role to the role

Name	Type	Description
role	Role	Instance of the role
child	Role | Permission	Instance of the role or permission
cb	function	Callback function

Returns:

instance

grantByName(roleName, childName, cb){RBAC}

RBAC.js, line 248

Grant permission or role from the role by names

Name	Type	Description
roleName	String	Instance of the role
childName	String	Instance of the role or permission
cb	function	Callback function

Returns:

instance

grants(List, cb){RBAC}

RBAC.js, line 498

Grant multiple items in one function

Name	Type	Description
List	Object	of roles
cb	function	Callback function

Returns:

instance

hasRole(roleName, roleChildName, cb){RBAC}

RBAC.js, line 742

Return true if role has allowed permission

Name	Type	Description
roleName	String	Name of role
roleChildName	String	Name of child role
cb	function	Callback function

Returns:

instance

remove(item, cb){RBAC}

RBAC.js, line 115

Remove role or permission from RBAC

Name	Type	Description
item	Role | Permission	Instance of role or permission
cb	function	Callback function

Returns:

instance

removeByName(name, cb){RBAC}

RBAC.js, line 138

Remove role or permission from RBAC

Name	Type	Description
name	String	Name of role or permission
cb	function	Callback function

Returns:

instance

revoke(role, child, cb){RBAC}

RBAC.js, line 192

Revoke permission or role from the role

Name	Type	Description
role	Role	Instance of the role
child	Role | Permission	Instance of the role or permission
cb	function	Callback function

Returns:

instance

revokeByName(roleName, childName, cb){RBAC}

RBAC.js, line 216

Revoke permission or role from the role by names

Name	Type	Description
roleName	String	Instance of the role
childName	String	Instance of the role or permission
cb	function	Callback function

Returns:

instance