@plusauth/plusauth-rest-js

Helper library for interacting with PlusAuth REST API intent upon to be used in NodeJS and browser environments.

Table Of Content

1. Installation
2. Usage
3. Docs
4. Examples

Installation

From PlusAuth CDN:

<!-- Latest release -->
<script src="https://unpkg.com/@plusauth/[email protected]/dist/plusauth-rest-js.min.js"></script>

With npm:

$ npm install @plusauth/plusauth-rest-js

or with yarn

$ yarn add @plusauth/plusauth-rest-js

Usage

CDN Usage

The library will be exposed to global as PlusAuthRestClient

Initialize it like following:

const authToken = '<ACCESS_TOKEN>'
const plusAuth = PlusAuthRestClient('https://<YOUR_TENANT_ID>.plusauth.com', { token: authToken })

NPM Usage

import { PlusAuthRestClient } from '@plusauth/plusauth-rest-js'

const authToken = '<ACCESS_TOKEN>'
const plusAuth = new PlusAuthRestClient('https://<YOUR_TENANT_ID>.plusauth.com', { token: authToken })

CommonJS

const { PlusAuthRestClient } = require('@plusauth/plusauth-rest-js')

const authToken = '<ACCESS_TOKEN>'
const plusAuth = new PlusAuthRestClient('https://<YOUR_TENANT_ID>.plusauth.com', { token: authToken })

Replacing Token

Generally you may need to replace PlusAuth REST API token because its lifetime could end. In this case updating options.token or by using the token setter of PlusAuthClient instance will be enough to change used token.

To generate access token consult docs or have a look at example/getAuthToken.js. The example file also includes an example curl request.

const initialToken = 'INITIAL_TOKEN'
const plusAuth = new PlusAuthRestClient('https://<YOUR_TENANT_ID>.plusauth.com', { token: initialToken })

plusAuth.users.getAll().then( function (res){
// retrieved with initial token
console.log(res)
})

// or: plusauth.options.token = 'NEW_TOKEN'
plusAuth.token = 'NEW_TOKEN'

plusAuth.users.getAll().then(function (res){
// Retrieved with new token
console.log(res)
})

Custom HTTP Client

You may provide your own http client to the library when you need to have more control over your requests.

const axios = require('axios')
const plusAuth = new PlusAuthRestClient('https://<YOUR_TENANT_ID>.plusauth.com', {
    httpClient: function (url, options) {
        options.url = url
        options.data = options.body
        return axios(options)
    }
})

Docs

For API docs visit here