@sricsl/auth-client

auth_client - JavaScript client for @sricsl/auth-client Authentication Service This SDK is automatically generated by the OpenAPI Generator project:

• API version: 2.0.0
• Package version: 2.1.1
• Build package: org.openapitools.codegen.languages.JavascriptClientCodegen

Installation

For Node.js

npm

To publish the library as a npm, please follow the procedure in "Publishing npm packages".

Then install it via:

npm install @sricsl/auth-client --save

Finally, you need to build the module:

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:

npm install

Next, link it globally in npm with the following, also from JAVASCRIPT_CLIENT_DIR:

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:

npm link /path/to/<JAVASCRIPT_CLIENT_DIR>

Finally, you need to build the module:

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:

    npm install GIT_USER_ID/GIT_REPO_ID --save

For browser

The library also works in the browser environment via npm and browserify. 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):

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:

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

Getting Started

Please follow the installation instruction and execute the following JS code:

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 | POST /auth/rest/users | add a user auth_client.AuthenticationServiceApi | changeDisplayName | POST /auth/rest/users/{username}/displayname | change display name auth_client.AuthenticationServiceApi | changeEmail | POST /auth/rest/users/{username}/email | change email auth_client.AuthenticationServiceApi | changePassword | POST /auth/rest/users/{username}/password | change password auth_client.AuthenticationServiceApi | deleteUser | DELETE /auth/rest/users/{username} | delete a user auth_client.AuthenticationServiceApi | getDisplayName | GET /auth/rest/users/{username}/displayname | get display name auth_client.AuthenticationServiceApi | getEmail | GET /auth/rest/users/{username}/email | get email auth_client.AuthenticationServiceApi | getRootInfo | GET /auth/rest | get service information auth_client.AuthenticationServiceApi | getUsernames | GET /auth/rest/users | get the usernames auth_client.AuthenticationServiceApi | login | POST /auth/rest/login | log in auth_client.AuthenticationServiceApi | refreshToken | POST /auth/rest/refresh | refresh token

Documentation for Models

• auth_client.DbUser
• auth_client.UserCredentials

Documentation for Authorization

bearerAuth

• Type: Bearer authentication (jwt)