qual_dev_labs_auth v1.0.0

qual_dev_labs_auth

QualDevLabsAuth - JavaScript client for qual_dev_labs_auth API for the QualDevLabs Auth library. 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 install qual_dev_labs_auth --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 qual_dev_labs_auth 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 QualDevLabsAuth = require('qual_dev_labs_auth');

var defaultClient = QualDevLabsAuth.ApiClient.instance;
// Configure API key authorization: apiKeyHeader
var apiKeyHeader = defaultClient.authentications['apiKeyHeader'];
apiKeyHeader.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//apiKeyHeader.apiKeyPrefix['x-api-key'] = "Token"

var api = new QualDevLabsAuth.DefaultApi()
var appId = "appId_example"; // {String} the app's UUID (unique)
var orgId = "orgId_example"; // {String} the org's UUID (unique)
var userSchema = new QualDevLabsAuth.UserSchema(); // {UserSchema} 
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.createUser(appId, orgId, userSchema, callback);

Documentation for API Endpoints

All URIs are relative to https://qualdevlabsauth.uc.r.appspot.com

Documentation for Models

• QualDevLabsAuth.EmailOfAccountThatIsResetingThePassword
• QualDevLabsAuth.LoginSchema
• QualDevLabsAuth.PasswordResetSchema
• QualDevLabsAuth.UserSchema
• QualDevLabsAuth.UserUpdatesSchema

Documentation for Authorization

apiKeyHeader

• Type: API key
• API key parameter name: x-api-key
• Location: HTTP header

passwordInHeader

• Type: API key
• API key parameter name: password
• Location: HTTP header

tokenHeader

• Type: API key
• API key parameter name: token
• Location: HTTP header