roles.md

Roles

Overview

The resources responsible for installing and managing roles

Available Resources

1. netField.roles.create(organisationId, params, [callback])

2. netField.roles.get(organisationId, roleName, [callback])

3. netField.roles.update(organisationId, params, [callback])

4. netField.roles.getAll(organisationId, page, [callback])

5. netField.roles.delete(organisationId, roleName, [callback])

Resource Usage

createrole

Create role

/**
 * @param {number} organisationId
 * @param {object} params
 * @param {function} callback optional
*/
netField.roles.create(organisationId, params, [callback])

getrole

Get role by organisationId and roleName

/**
 * @param {number} organisationId
 * @param {string} roleName
 * @param {function} callback optional
*/
netField.roles.get(organisationId, roleName, [callback])

updaterole

Update role

/**
 * @param {number} organisationId
 * @param {object} params
 * @param {function} callback optional
*/
netField.roles.update(organisationId, params, [callback])

getroles

Get roles by organisationId

/**
 * @param {number} organisationId
 * @param {number} page
 * @param {function} callback optional
*/
netField.roles.getAll(organisationId, page, [callback])

deleterole

Delete role

/**
 * @param {number} organisationId
 * @param {string} roleName
 * @param {function} callback optional
*/
netField.roles.delete(organisationId, roleName, [callback])