npm package: @sricsl/auth-client
Description: Authentication_Service
Latest version: 2.1.1

# @sricsl/auth-client

auth_client - JavaScript client for @sricsl/auth-client
Authentication Service
This SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:

- API version: 2.0.0
- Package version: 2.1.1
- 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 @sricsl/auth-client --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 @sricsl/auth-client 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 auth_client = require('@sricsl/auth-client');

var defaultClient = auth_client.ApiClient.instance;
// Configure Bearer (jwt) access token for authorization: bearerAuth
var bearerAuth = defaultClient.authentications['bearerAuth'];
bearerAuth.accessToken = "YOUR ACCESS TOKEN"

var api = new auth_client.AuthenticationServiceApi()
var dbUser = new auth_client.DbUser(); // {DbUser} user
api.addUser(dbUser).then(function(data) {
  console.log('API called successfully. Returned data: ' + data);
}, function(error) {
  console.error(error);
});


```

## Documentation for API Endpoints

All URIs are relative to *http://localhost*

Class | Method | HTTP request | Description
------------ | ------------- | ------------- | -------------
*auth_client.AuthenticationServiceApi* | [**addUser**](docs/AuthenticationServiceApi.md#addUser) | **POST** /auth/rest/users | add a user
*auth_client.AuthenticationServiceApi* | [**changeDisplayName**](docs/AuthenticationServiceApi.md#changeDisplayName) | **POST** /auth/rest/users/{username}/displayname | change display name
*auth_client.AuthenticationServiceApi* | [**changeEmail**](docs/AuthenticationServiceApi.md#changeEmail) | **POST** /auth/rest/users/{username}/email | change email
*auth_client.AuthenticationServiceApi* | [**changePassword**](docs/AuthenticationServiceApi.md#changePassword) | **POST** /auth/rest/users/{username}/password | change password
*auth_client.AuthenticationServiceApi* | [**deleteUser**](docs/AuthenticationServiceApi.md#deleteUser) | **DELETE** /auth/rest/users/{username} | delete a user
*auth_client.AuthenticationServiceApi* | [**getDisplayName**](docs/AuthenticationServiceApi.md#getDisplayName) | **GET** /auth/rest/users/{username}/displayname | get display name
*auth_client.AuthenticationServiceApi* | [**getEmail**](docs/AuthenticationServiceApi.md#getEmail) | **GET** /auth/rest/users/{username}/email | get email
*auth_client.AuthenticationServiceApi* | [**getRootInfo**](docs/AuthenticationServiceApi.md#getRootInfo) | **GET** /auth/rest | get service information
*auth_client.AuthenticationServiceApi* | [**getUsernames**](docs/AuthenticationServiceApi.md#getUsernames) | **GET** /auth/rest/users | get the usernames
*auth_client.AuthenticationServiceApi* | [**login**](docs/AuthenticationServiceApi.md#login) | **POST** /auth/rest/login | log in
*auth_client.AuthenticationServiceApi* | [**refreshToken**](docs/AuthenticationServiceApi.md#refreshToken) | **POST** /auth/rest/refresh | refresh token


## Documentation for Models

 - [auth_client.DbUser](docs/DbUser.md)
 - [auth_client.UserCredentials](docs/UserCredentials.md)


## Documentation for Authorization



### bearerAuth

- **Type**: Bearer authentication (jwt)