bcgov / mdms-nodejs-client

An NPM package to wrap the client API calls for the BCGov Mobile Device Management System (MDMS).
Apache License 2.0
0 stars 0 forks source link

About

For applications that need to manage AirWatch, we provide an API wrapper of the AirWatch Client

Usage

Install via npm as you would with any other package by supplying both the repo URL and branch or tag reference. In the example below the tag v0.0.1 is used.

npm i -S @bcgov/mdms-nodejs-client

You can also directly add it to your package.json file by inserting the following line into your dependencies section:

"@bcgov/mdms-nodejs-client": "git+https://git@github.com/bcgov/mdms-nodejs-client.git#v0.1.0",

Once you installed you can can use it like any other module:

import { getAllOrgGroups } from '@bcgov/mdms-nodejs-client';

* You can also use the ssh protocol preferred.

For Example, to get a list of all organization groups in AirWatch, including the sub origanization groups:

// Set the AW credentials as env vars:
//  AW_HOST
//  AW_TENANT_CODE
//  AW_USERNAME
//  AW_PASSWORD

const credentials = {
  host: process.env.AW_HOST,
  tenantCode: process.env.AW_TENANT_CODE,
  username: process.env.AW_USERNAME,
  password: process.env.AW_PASSWORD,
};

// You will need to know the ID of the root organization group in AirWatch:
const rootOrgID = 0;

// Default is false
const includeChildren = true;

const allOrgGroups = await getAllOrgGroups(credentials, rootOrgID, includeChildren);

Project Status / Goals / Roadmap

This project is active.

Getting Help or Reporting an Issue

Send a note to bcdevexchange@gov.bc.ca and you'll get routed to the right person to help you out.

How to Contribute

Create a pull request with your code. Its really that simple.

* If you are including a Code of Conduct, make sure that you have a CODE_OF_CONDUCT.md file, and include the following text in here in the README:* "Please note that this project is released with a Contributor Code of Conduct. By participating in this project you agree to abide by its terms."

License

Copyright 2018 Province of British Columbia

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

   http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.

Creative Commons Licence
mdms-nodejs-client by the Province of British Columbia is licensed under a Creative Commons Attribution 4.0 International License.