npm package: @p7m/ldap-backend
Description: Manage WiFi accounts via LDAP directory
Latest version: 0.1.0

# @p7m/ldap-backend

LdapBackend - JavaScript client for @p7m/ldap-backend
Manage WiFi accounts via LDAP directory
This SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:

- API version: 0.1.0
- Package version: 0.1.0
- Generator version: 7.13.0-SNAPSHOT
- Build package: org.openapitools.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 @p7m/ldap-backend --save
```

Finally, you need to build the module:

```shell
npm run build
```

##### Local development

To use the library locally without publishing to a remote npm registry, first install the dependencies by changing into the directory containing `package.json` (and this README). Let's call this `JAVASCRIPT_CLIENT_DIR`. Then run:

```shell
npm install
```

Next, [link](https://docs.npmjs.com/cli/link) it globally in npm with the following, also from `JAVASCRIPT_CLIENT_DIR`:

```shell
npm link
```

To use the link you just defined in your project, switch to the directory you want to use your @p7m/ldap-backend from, and run:

```shell
npm link /path/to/<JAVASCRIPT_CLIENT_DIR>
```

Finally, you need to build the module:

```shell
npm run build
```

#### git

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

```shell
    npm install GIT_USER_ID/GIT_REPO_ID --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.

### Webpack Configuration

Using Webpack you may encounter the following error: "Module not found: Error:
Cannot resolve module", most certainly you should disable AMD loader. Add/merge
the following section to your webpack config:

```javascript
module: {
  rules: [
    {
      parser: {
        amd: false
      }
    }
  ]
}
```

## Getting Started

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

```javascript
var LdapBackend = require('@p7m/ldap-backend');

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

var api = new LdapBackend.AccountApi()
var accountId = "accountId_example"; // {String} ID of the LDAP/WiFi accuont
api.deleteAccountsAccountId(accountId).then(function() {
  console.log('API called successfully.');
}, function(error) {
  console.error(error);
});


```

## Documentation for API Endpoints

All URIs are relative to *https://ldap.api.p7m.de/v1*

Class | Method | HTTP request | Description
------------ | ------------- | ------------- | -------------
*LdapBackend.AccountApi* | [**deleteAccountsAccountId**](docs/AccountApi.md#deleteAccountsAccountId) | **DELETE** /accounts/{account_id} | Delete a single LDAP/WiFi account by its ID
*LdapBackend.AccountApi* | [**getAccounts**](docs/AccountApi.md#getAccounts) | **GET** /accounts | Get the list of all LDAP/WiFi accounts
*LdapBackend.AccountApi* | [**getAccountsAccountId**](docs/AccountApi.md#getAccountsAccountId) | **GET** /accounts/{account_id} | Get a single LDAP/WiFi account by its ID
*LdapBackend.AccountApi* | [**postAccounts**](docs/AccountApi.md#postAccounts) | **POST** /accounts | Create a new LDAP/WiFi account
*LdapBackend.AccountApi* | [**putAccountsAccountId**](docs/AccountApi.md#putAccountsAccountId) | **PUT** /accounts/{account_id} | Update an existing LDAP/WiFi account


## Documentation for Models

 - [LdapBackend.LdapAccount](docs/LdapAccount.md)
 - [LdapBackend.ListWrapperLdapAccount](docs/ListWrapperLdapAccount.md)
 - [LdapBackend.ListWrapperLdapAccountDataInner](docs/ListWrapperLdapAccountDataInner.md)
 - [LdapBackend.NewLdapAccount](docs/NewLdapAccount.md)


## Documentation for Authorization


Authentication schemes defined for the API:
### oauth


- **Type**: OAuth
- **Flow**: accessCode
- **Authorization URL**: https://login.p7m.de/auth/authorize
- **Scopes**: N/A