Introduction

This article describes the Igloo Node.js authentication module, herein referred to as igAuth.

Prerequisites

The Igloo Node.js server uses the following npm modules:

The Igloo Node.js server uses the following custom modules:

Configuration

Click below to download the Igloo authentication module for Node.js (Fig. 3.1):

Include this JS file with your other custom node modules, and simply require it (Fig 3.2):

/**
 * @desc Require igAuth.js in your Node.js main executable JS file
 */
var igAuth = require("./igAuth.js");

To sign-in, simply call igAuth.signIn(); where necessary (Fig. 3.3)

/**
 * @desc Call the function to complete the sign-in process
 */
igAuth.signIn();

igAuth.js overview

// igAuth.js

/**
 * A module that authenticates and creates an active Igloo session
 * @module signIn
 */

/** External authentication using the superagent package */
const request = require('superagent');

/** igAuth.signIn() */
exports.signIn = function () {
    /** Igloo issued credentials */
    let credentials = {
        appId: "000df22c-ece6-4484-a00b-4dc2200eca31",  // API Key provided by Igloo to the developer
        appPass: "a-secure-api-password",               // API Password provided by Igloo to the developer
        username: "your-user-login@domain.com",         // Your Igloo username
        password: "password",                           // Your Igloo password
        community: 'mycommunity.igloocommunities.com'   // The FQDN of your Igloo community
    };

    /** superagent request to connect to the Igloo site */
    request
        .post('https://mycommunity.igloocommunities.com/.api/api.svc/session/create')   // Change to the URL of your Igloo community
        .set('Accept', 'application/json')
        .set('Content-Type', 'application/x-www-form-urlencoded')
        .send(`appId=${credentials.appId}&appPass=${credentials.appPass}&username=${credentials.username}&password=${credentials.password}&community=${credentials.community}&apiversion=1`)
        .end(function (err, res) {
            if (err || !res.ok) {
                console.error('Unable to create session', err);
            } else {
                /** Your custom code here... */

                console.info('Here is your igloo session data:', res.body);
                console.info('Your iglooauth session key is:', res.body.response.sessionKey);
            }
        });
};