# cst_device_management_service_web_api

CstDeviceManagementServiceWebApi - JavaScript client for cst_device_management_service_web_api
The device management web API allows users to manage their DOF domain.  Fields may be defined with the following properties:   * Read-only - Can never be set, always generated by the server    * Immutable - Can be set when first created but can never change after that   * Write-only - Can only be written and will never appear as output   Unless otherwise specified, all date/time fields are represented as specified by  [RFC 3339](https://www.ietf.org/rfc/rfc3339.txt). E.g. 2015-04-12T23:20:50.52Z 
This SDK is automatically generated by the [Swagger Codegen](https://github.com/swagger-api/swagger-codegen) project:

- API version: 1.0.0
- Package version: 1.0.0
- Build date: 2016-08-11T17:31:15.853Z
- Build package: class io.swagger.codegen.languages.JavascriptClientCodegen

## Installation

### For [Node.js](https://nodejs.org/)

#### npm

To publish the library as a [npm](https://www.npmjs.com/),
please follow the procedure in ["Publishing npm packages"](https://docs.npmjs.com/getting-started/publishing-npm-packages).

Then install it via:

```shell
npm install cst_device_management_service_web_api --save
```

#### git
#
If the library is hosted at a git repository, e.g.
https://github.com/YOUR_USERNAME/cst_device_management_service_web_api
then install it via:

```shell
    npm install YOUR_USERNAME/cst_device_management_service_web_api --save
```

### For browser

The library also works in the browser environment via npm and [browserify](http://browserify.org/). After following
the above steps with Node.js and installing browserify with `npm install -g browserify`,
perform the following (assuming *main.js* is your entry file):

```shell
browserify main.js > bundle.js
```

Then include *bundle.js* in the HTML pages.

## Getting Started

Please follow the [installation](#installation) instruction and execute the following JS code:

```javascript
var CstDeviceManagementServiceWebApi = require('cst_device_management_service_web_api');

var defaultClient = CstDeviceManagementServiceWebApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: AccessToken
var AccessToken = defaultClient.authentications['AccessToken'];
AccessToken.accessToken = "YOUR ACCESS TOKEN"

var api = new CstDeviceManagementServiceWebApi.CredentialsApi()

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getCredentials(callback);

```

## Documentation for API Endpoints

All URIs are relative to *https://devicemanagement.cstkit.com*

Class | Method | HTTP request | Description
------------ | ------------- | ------------- | -------------
*CstDeviceManagementServiceWebApi.CredentialsApi* | [**getCredentials**](docs/CredentialsApi.md#getCredentials) | **GET** /credentials | 
*CstDeviceManagementServiceWebApi.NodeApi* | [**addNode**](docs/NodeApi.md#addNode) | **POST** /nodes | 
*CstDeviceManagementServiceWebApi.NodeApi* | [**deleteNode**](docs/NodeApi.md#deleteNode) | **DELETE** /nodes/{nodeID} | 
*CstDeviceManagementServiceWebApi.NodeApi* | [**getNode**](docs/NodeApi.md#getNode) | **GET** /nodes/{nodeID} | 
*CstDeviceManagementServiceWebApi.NodeApi* | [**getNodes**](docs/NodeApi.md#getNodes) | **GET** /nodes | 
*CstDeviceManagementServiceWebApi.NodeApi* | [**updateNode**](docs/NodeApi.md#updateNode) | **PUT** /nodes/{nodeID} | 


## Documentation for Models

 - [CstDeviceManagementServiceWebApi.Credentials](docs/Credentials.md)
 - [CstDeviceManagementServiceWebApi.Error](docs/Error.md)
 - [CstDeviceManagementServiceWebApi.MyCredentials](docs/MyCredentials.md)
 - [CstDeviceManagementServiceWebApi.Node](docs/Node.md)
 - [CstDeviceManagementServiceWebApi.NodePage](docs/NodePage.md)
 - [CstDeviceManagementServiceWebApi.OAuth2Error](docs/OAuth2Error.md)


## Documentation for Authorization


### AccessToken

- **Type**: OAuth
- **Flow**: implicit
- **Authorization URL**: https://cstkit.com/oauth2/authorize
- **Scopes**: 
  - id: View the userID and domain associated with your account.

  - dof: Access to the user's OpenDOF credentials.

  - dof_admin: Access to the dof authentication management API.