# qual_dev_labs_auth > API_for_the_QualDevLabs_Auth_library_ Latest version **1.0.0** (published 2021-12-30) · MIT license · 0 weekly downloads ## Install ```sh npm install qual_dev_labs_auth pnpm add qual_dev_labs_auth yarn add qual_dev_labs_auth bun add qual_dev_labs_auth ``` ## Health **Score 15/100 (F)** — status: abandoned. Positive: no vulnerabilities. Warnings: low downloads; no types; no esm support. Negative: abandoned; low maintenance score. ## Facts | | | |---|---| | Version | 1.0.0 | | Published | 2021-12-30 | | First published | 2021-12-30 | | Weekly downloads | 0 | | License | MIT | | TypeScript types | none | | Module format | CommonJS | | Dependencies | 2 | | Unpacked size | 85.7 KB | | Known vulnerabilities | 0 | | Install scripts | no | | Maintainers | qualdevlabs | ## Links - npm: https://www.npmjs.com/package/qual_dev_labs_auth - npm.io page: https://npm.io/package/qual_dev_labs_auth ## Dependencies (2) - [@babel/cli](https://npm.io/package/@babel/cli.md) ^7.0.0 - [superagent](https://npm.io/package/superagent.md) ^5.3.0 ## Recent versions - 1.0.0 (latest) — 2021-12-30 ## README # 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](https://openapi-generator.tech) project: - API version: 1.0.0 - Package version: 1.0.0 - 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 qual_dev_labs_auth --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 qual_dev_labs_auth from, and run: ```shell npm link /path/to/ ``` 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 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* Class | Method | HTTP request | Description ------------ | ------------- | ------------- | ------------- *QualDevLabsAuth.DefaultApi* | [**createUser**](docs/DefaultApi.md#createUser) | **POST** /orgs/{orgId}/apps/{appId}/users | Creates a new user. *QualDevLabsAuth.DefaultApi* | [**createUserSession**](docs/DefaultApi.md#createUserSession) | **POST** /orgs/{orgId}/apps/{appId}/sessions | Login user *QualDevLabsAuth.DefaultApi* | [**deleteUser**](docs/DefaultApi.md#deleteUser) | **DELETE** /orgs/{orgId}/apps/{appId}/users/{userId} | Delete a user *QualDevLabsAuth.DefaultApi* | [**deleteUserSession**](docs/DefaultApi.md#deleteUserSession) | **DELETE** /orgs/{orgId}/apps/{appId}/sessions/{userId} | Logout user *QualDevLabsAuth.DefaultApi* | [**forgotPasswordReset**](docs/DefaultApi.md#forgotPasswordReset) | **PATCH** /orgs/{orgId}/apps/{appId}/password_reset | resets an unathenticated user's password using a token sent to their email *QualDevLabsAuth.DefaultApi* | [**requestPasswordResetToken**](docs/DefaultApi.md#requestPasswordResetToken) | **POST** /orgs/{orgId}/apps/{appId}/password_reset_tokens | requests a password reset token for user's who have forgotten their password *QualDevLabsAuth.DefaultApi* | [**updateImportantUserDetails**](docs/DefaultApi.md#updateImportantUserDetails) | **PATCH** /orgs/{orgId}/apps/{appId}/users/{userId} | Updates a user's important details *QualDevLabsAuth.DefaultApi* | [**validateSession**](docs/DefaultApi.md#validateSession) | **GET** /orgs/{orgId}/apps/{appId}/sessions/{userId} | Verifies if session is valid ## Documentation for Models - [QualDevLabsAuth.EmailOfAccountThatIsResetingThePassword](docs/EmailOfAccountThatIsResetingThePassword.md) - [QualDevLabsAuth.LoginSchema](docs/LoginSchema.md) - [QualDevLabsAuth.PasswordResetSchema](docs/PasswordResetSchema.md) - [QualDevLabsAuth.UserSchema](docs/UserSchema.md) - [QualDevLabsAuth.UserUpdatesSchema](docs/UserUpdatesSchema.md) ## 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 --- _Source: https://npm.io/package/qual_dev_labs_auth · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._