codecrew_auth_service

auth_service

AuthService - JavaScript client for auth_service This API provides token-based authentication for user registration, login, and client credential management. It ensures secure communication by utilizing tokens for authentication. Users can register with unique usernames and passwords, authenticate using client credentials, retrieve client IDs and secrets, and regenerate client credentials as needed. The API supports various user roles, including 'user', 'admin', 'moderator', 'guest', and 'superadmin'. This SDK is automatically generated by the OpenAPI Generator project:

• API version: 1.0.0
• Package version: 1.0.0
• 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 i codecrew_auth_service

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 auth_service 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 CodeCrew24/authservice_javascript --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 AuthService = require('auth_service');


var api = new AuthService.DefaultApi()
var username = johndoe; // {String} User's username
var password = password123; // {String} User's password
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.clientGet(username, password, callback);

Documentation for API Endpoints

All URIs are relative to https://auth-service-latest.onrender.com/auth

Class	Method	HTTP request	Description
AuthService.DefaultApi	clientGet	GET /client	Get client ID and secret
AuthService.DefaultApi	loginClientPost	POST /login/client	Logs in a user using client ID and secret
AuthService.DefaultApi	regenerateClientCredentialsPost	POST /regenerate-client-credentials	Regenerate client credentials
AuthService.DefaultApi	registerPost	POST /register	Registers a new user

Documentation for Models

• AuthService.ClientGet200Response
• AuthService.ClientGet401Response
• AuthService.LoginClientPost200Response
• AuthService.LoginClientPost401Response
• AuthService.RegenerateClientCredentialsPost200Response
• AuthService.RegisterPost201Response
• AuthService.RegisterPost400Response
• AuthService.RegisterPost500Response

Documentation for Authorization

Endpoints do not require authorization.