npm package: @p7m/userauth-backend
Description: # API for authentication and managing user accounts  This is the API of the service at P7M that manages tenants, accounts and authentication. It is the basis of many services of P7M.  The caller has to be authenticated with the system and provide a JWT to
Latest version: 0.14.2

# @p7m/userauth-backend

UserAuthBackend - JavaScript client for @p7m/userauth-backend
# API for authentication and managing user accounts

This is the API of the service at P7M that manages tenants, accounts and authentication. It is the basis of many
services of P7M.

The caller has to be authenticated with the system and provide a JWT token in the Authorization header of
the HTTP request. When using the API you typically get this token by authenticating first with OAuth 2.0.

When you are trying this API using the Swagger interface, you need to click the `Authorize` button and then again
the Authorize button in the pop-up that gets opened.
This SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:

- API version: 0.14.2
- Package version: 0.14.2
- 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/userauth-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/userauth-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 UserAuthBackend = require('@p7m/userauth-backend');

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

var api = new UserAuthBackend.AccountApi()
var id = "id_example"; // {String} ID of the account
api.deleteAccountById(id).then(function() {
  console.log('API called successfully.');
}, function(error) {
  console.error(error);
});


```

## Documentation for API Endpoints

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

Class | Method | HTTP request | Description
------------ | ------------- | ------------- | -------------
*UserAuthBackend.AccountApi* | [**deleteAccountById**](docs/AccountApi.md#deleteAccountById) | **DELETE** /accounts/{id} | Delete a user account
*UserAuthBackend.AccountApi* | [**getAccountById**](docs/AccountApi.md#getAccountById) | **GET** /accounts/{id} | Get an account, that is known by its ID (UUID)
*UserAuthBackend.AccountApi* | [**getAccounts**](docs/AccountApi.md#getAccounts) | **GET** /accounts | Get the list of all accounts of the tenant
*UserAuthBackend.AccountApi* | [**postAccounts**](docs/AccountApi.md#postAccounts) | **POST** /accounts | 
*UserAuthBackend.AccountApi* | [**putAccountById**](docs/AccountApi.md#putAccountById) | **PUT** /accounts/{id} | Update an existing account
*UserAuthBackend.AuthApi* | [**postLogin**](docs/AuthApi.md#postLogin) | **POST** /login | Authenticate (&#x3D; proof who you are) to the system using a username and password
*UserAuthBackend.AuthApi* | [**postLoginAuthorize**](docs/AuthApi.md#postLoginAuthorize) | **POST** /login/authorize | Authorize access to a given tenant and get JWT for that access
*UserAuthBackend.ClientApi* | [**deleteClientsByIdSuperadmin**](docs/ClientApi.md#deleteClientsByIdSuperadmin) | **DELETE** /clients/{id} | Deletes an OAuth client
*UserAuthBackend.ClientApi* | [**getClientsByIdSuperadmin**](docs/ClientApi.md#getClientsByIdSuperadmin) | **GET** /clients/{id} | Requests a single OAuth client by its ID
*UserAuthBackend.ClientApi* | [**getClientsSuperadmin**](docs/ClientApi.md#getClientsSuperadmin) | **GET** /clients | Gets the list of all registered OAuth clients
*UserAuthBackend.ClientApi* | [**postClientsSuperadmin**](docs/ClientApi.md#postClientsSuperadmin) | **POST** /clients | Create a new OAuth client
*UserAuthBackend.ClientApi* | [**putClientsByIdSuperadmin**](docs/ClientApi.md#putClientsByIdSuperadmin) | **PUT** /clients/{id} | Updates an OAuth client
*UserAuthBackend.ServiceApi* | [**deleteServicesSuperadmin**](docs/ServiceApi.md#deleteServicesSuperadmin) | **DELETE** /services/{id} | Deletes a service
*UserAuthBackend.ServiceApi* | [**getServices**](docs/ServiceApi.md#getServices) | **GET** /services | Get the list of all known services of P7M
*UserAuthBackend.ServiceApi* | [**postServicesSuperadmin**](docs/ServiceApi.md#postServicesSuperadmin) | **POST** /services | Create a new service
*UserAuthBackend.TenantApi* | [**deleteTenantById**](docs/TenantApi.md#deleteTenantById) | **DELETE** /tenants/{id} | Delete a tenant specified by the tenant&#39;s ID
*UserAuthBackend.TenantApi* | [**getTenantById**](docs/TenantApi.md#getTenantById) | **GET** /tenants/{id} | Request a the tenant identified by its ID
*UserAuthBackend.TenantApi* | [**getTenants**](docs/TenantApi.md#getTenants) | **GET** /tenants | Get the list of tenants
*UserAuthBackend.TenantApi* | [**postTenants**](docs/TenantApi.md#postTenants) | **POST** /tenants | 
*UserAuthBackend.TenantApi* | [**putTenantById**](docs/TenantApi.md#putTenantById) | **PUT** /tenants/{id} | Update an existing tenant


## Documentation for Models

 - [UserAuthBackend.Account](docs/Account.md)
 - [UserAuthBackend.AuthorizationRequest](docs/AuthorizationRequest.md)
 - [UserAuthBackend.AuthorizationResponse](docs/AuthorizationResponse.md)
 - [UserAuthBackend.Client](docs/Client.md)
 - [UserAuthBackend.ClientUpdate](docs/ClientUpdate.md)
 - [UserAuthBackend.ListWrapperAccount](docs/ListWrapperAccount.md)
 - [UserAuthBackend.ListWrapperAccountDataInner](docs/ListWrapperAccountDataInner.md)
 - [UserAuthBackend.ListWrapperClient](docs/ListWrapperClient.md)
 - [UserAuthBackend.ListWrapperClientDataInner](docs/ListWrapperClientDataInner.md)
 - [UserAuthBackend.ListWrapperService](docs/ListWrapperService.md)
 - [UserAuthBackend.ListWrapperServiceDataInner](docs/ListWrapperServiceDataInner.md)
 - [UserAuthBackend.ListWrapperTenant](docs/ListWrapperTenant.md)
 - [UserAuthBackend.ListWrapperTenantDataInner](docs/ListWrapperTenantDataInner.md)
 - [UserAuthBackend.NewAccount](docs/NewAccount.md)
 - [UserAuthBackend.NewClient](docs/NewClient.md)
 - [UserAuthBackend.NewService](docs/NewService.md)
 - [UserAuthBackend.NewTenant](docs/NewTenant.md)
 - [UserAuthBackend.PasswordLoginAttempt](docs/PasswordLoginAttempt.md)
 - [UserAuthBackend.PasswordLoginResponse](docs/PasswordLoginResponse.md)
 - [UserAuthBackend.Service](docs/Service.md)
 - [UserAuthBackend.Tenant](docs/Tenant.md)
 - [UserAuthBackend.UserType](docs/UserType.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