Skip to content

Latest commit

 

History

History
41 lines (28 loc) · 1.18 KB

README.md

File metadata and controls

41 lines (28 loc) · 1.18 KB
Raw

ux4iot-admin-node

ux4iot-admin-node provides a Node.js admin client for ux4iot. Use this library to easily access grant requests to the ux4iot service.

Prerequisites

In order to use this library you need to have an ux4iot instance deployed in your Azure subscription. Here is a link to a quickstart that explains how to deploy one. Here is the link to the Azure Marketplace offering.

Installation

npm install ux4iot-admin-node

Usage

import Ux4iotAdminSDK from 'ux4iot-admin-node';

const sdk = new Ux4iotAdminSDK({ connectionString: 'YOUR_UX4IOT_CONNECTION_STRING' });

const grantRequest = {
    deviceId: 'mydevice',
    sessionId: 'valid-session-id',
    type: 'telemetry',
    telemetryKey: 'mytelemetry'
}

await sdk.grant(grantRequest);

Documentation

Check out the Documentation for

  • API documentation on grant requests with ux4iot
  • Why you would need to use this library when using ux4iot
  • How to write a security backend for ux4iot