keys.md

Keys

Overview

The resources responsible for installing and managing keys

Available Resources

1. netField.keys.create(params, [callback])

2. netField.keys.delete(keyId, [callback])

3. netField.keys.getkeys(organisationId, page, limit, sortBy, sortOrder, [callback])

4. netField.keys.getkey(keyId, [callback])

5. netField.keys.updatekey(keyId, params, [callback])

6. netField.keys.getkeypermissions([callback])

7. netField.keys.createsensoredgekey([callback])

Resource Usage

createkey

Create key

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

deletekey

Delete key by keyId

/*
 * @param {keyId} string
 * @param {function} callback optional
*/
netField.keys.delete(keyId, [callback])

getkeys

Get all keys by organisationId

/**
 * @param {organisationId} number
 * @param {number} page
 * @param {number} limit
 * @param {string} sortBy
 * @param {string} sortOrder
 * @param {function} callback optional
*/
netField.keys.getkeys(organisationId, page, limit, sortBy, sortOrder, [callback])

getkey

Get key by keyId

/**
 * @param {keyId} string
 * @param {function} callback optional
*/
netField.keys.getkey(keyId, [callback])

updatekey

Update api key

/**
 * @param {keyId} string
 * @param {object} params
 * @param {function} callback optional
*/
netField.keys.updatekey(keyId, params, [callback])

getkeypermissions

Get api key resource data

/**
 * @param {function} callback optional
*/
netField.keys.getkeypermissions([callback])

createsensoredgekey

Create a key for SensorEdge tenant

/**
 * @param {object} params
 * @param {function} callback optional
*/
netField.keys.createsensoredgekey(params, [callback])