(Node.js) SharePoint Online Authentication

Demonstrates how to authenticate with SharePoint Online. The end result of authentication is to establish an HTTP cookie, named "SPOIDCRL", that contains a binary security token to be sent in subsequent SharePoint HTTPS requests.

The SPOIDCRL cookie can be persisted to a file and re-used in subsequent application runs.

Important: This example uses a method, SharePointOnlineAuth, that is introduced in Chilkat v9.5.0.73.

Also Important: Chilkat realizes there may be cases where your situation is such that it does not work, and something additional is required to make it work. If the example does not work out-of-the-box, please send email to support@chilkatsoft.com. The information logged to the LastErrorText property has been carefully crafted to help solve problems quickly. Also, the JSON argument to the SharePointOnlineAuth method provides a means to include additional information, whatever it may be, to handle future unknown situations.

Install Chilkat for Node.js and Electron using npm at Chilkat npm packages for Node.js Chilkat npm packages for Electron on Windows, Linux, MacOSX, and ARM

var os = require('os');
if (os.platform() == 'win32') {  
    if (os.arch() == 'ia32') {
        var chilkat = require('@chilkat/ck-node21-win-ia32');
    } else {
        var chilkat = require('@chilkat/ck-node21-win64'); 
    }
} else if (os.platform() == 'linux') {
    if (os.arch() == 'arm') {
        var chilkat = require('@chilkat/ck-node21-arm');
    } else if (os.arch() == 'x86') {
        var chilkat = require('@chilkat/ck-node21-linux32');
    } else {
        var chilkat = require('@chilkat/ck-node21-linux64');
    }
} else if (os.platform() == 'darwin') {
    if (os.arch() == 'arm64') {
        var chilkat = require('@chilkat/ck-node21-mac-m1');
    } else {
        var chilkat = require('@chilkat/ck-node21-macosx');
    }
}

function chilkatExample() {

    // This requires the Chilkat API to have been previously unlocked.
    // See Global Unlock Sample for sample code.

    var success;
    var http = new chilkat.Http();

    // Change these things...
    // Make sure to use "https" and end in a "/".
    var siteUrl = "https://mydomain.sharepoint.com/";
    // The username is an email address.
    var username = "username@mydomain.com";

    // The jsonExtra is for future use, if extra information is required for particular integrations.
    var jsonExtra = new chilkat.JsonObject();

    var ssPassword = new chilkat.SecureString();
    ssPassword.Append("mypassword");

    // Set properties to save/send cookies, and specify a cookie directory.
    // If the CookieDir = "memory", then the SPOIDCRL cookie is persisted in memory for this HTTP object instance only.
    // To persist the SharePoint authentication cookie for other HTTP objects, and for future application runs,
    // set the CookieDir equal to a directory path (not a specific file path, but a directory path where cookie files
    // are to be created).
    http.SaveCookies = true;
    http.SendCookies = true;
    http.CookieDir = "memory";

    // The SharePointOnlineAuth method is introduced in Chilkat v9.5.0.73
    success = http.SharePointOnlineAuth(siteUrl,username,ssPassword,jsonExtra);
    if (success == false) {
        console.log(http.LastErrorText);
        return;
    }

    console.log("Success! We have the SPOIDCRL cookie...");

    // -----------------------------------------------------------------------------------------------------------
    // IMPORTANT:
    // The purpose of the SharePointOnlineAuth method is to establish the SPOIDCRL cookie that will automatically be
    // included in subsequent requests using the *** same HTTP object instance. ***
    // If later you create a new HTTP object instance, then you'll need to re-establish the SPOIDCRL cookie before sending 
    // a Sharepoint HTTP request.
    // -----------------------------------------------------------------------------------------------------------

    // SharePoint authenticated requests may now be sent because the authentication cookie is automatically included.
    // For example:
    var sbResponseXml = new chilkat.StringBuilder();
    // If your Sharepoint site is within a site collection, then use "https://mydomain.sharepoint.com/sites/teamA/_api/web/GetFolderByServerRelativeUrl('/sites/teamA/Documents')/Files" where "teamA" is the name of the site.
    success = http.QuickGetSb("https://mydomain.sharepoint.com/_api/web/GetFolderByServerRelativeUrl('/Documents')/Files",sbResponseXml);
    if (success == false) {
        console.log(http.LastErrorText);
        return;
    }

    console.log("Response status code = " + http.LastStatus);

    var xml = new chilkat.Xml();
    xml.LoadSb(sbResponseXml,true);
    console.log(xml.GetXml());

}

chilkatExample();