unibot-authmodule v1.0.4

AuthModule

Introduction

This module's purpose is to handle the access token in a node application. It contains one class AuthModule which contains fields with information about the authentification service URL, credentials of the application and the access token. The authentification service URL and the credentials of the application can be set by the user of this module and the access token can be retreived. There is an exemple of use of the AuthModule in the file src/script.ts

AuthModule class

Fields

• accessToken : this field contains the access token
• auth_url: this field contains the Authentification Service URL (set in constructor)
• client_id: the client_id used to authenticate (set in constructor)
• client_secret: the client_secret used to authenticate (set in constructor)

Constructor

public constructor(auth_url: string, client_id: string, client_secret: string);

Methods

• public getAccessToken(): returns the access token
• public async login(): retreive the access token, returns a Promise

How to use the access token to access a protected REST endpoint

To use the access token, you need to :

• Create an header for your HTTP request with the Authorization field
• set this field with the value Bearer accessToken where accessToken is your access token (accessible with getAccessToken())

ex : 'Authorization: Bearer da6bf5cd-9896-4505-8dd6-18c121a5584a'