https://github.com/deviceinsight/ux4iot-admin-node
https://github.com/deviceinsight/ux4iot-admin-node
Last synced: 11 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/deviceinsight/ux4iot-admin-node
- Owner: deviceinsight
- License: mit
- Created: 2021-09-27T11:30:14.000Z (almost 5 years ago)
- Default Branch: master
- Last Pushed: 2024-03-22T08:11:07.000Z (over 2 years ago)
- Last Synced: 2024-05-07T18:28:12.701Z (about 2 years ago)
- Language: TypeScript
- Size: 382 KB
- Stars: 4
- Watchers: 6
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# 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](https://docs.ux4iot.com/quickstart)
is a link to a quickstart that explains how to deploy one. [Here](https://azuremarketplace.microsoft.com/en-us/marketplace/apps/deviceinsightgmbh-4961725.ux4iot)
is the link to the Azure Marketplace offering.
## Installation
```
npm install ux4iot-admin-node
```
## Usage
```ts
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](https://docs.ux4iot.com/implementing-your-custom-security-backend/introduction) 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