ADFS user credentials authentication

For SharePoint Online

node-sp-auth automatically determines if your organization is using federated identity and requests authentication using your ADFS server. All you need is to pass username and password, like you normally do for User Credentials. username will be equal to your's company user name, i.e. johnsmith@contoso.com.

For SharePoint on-premise

ADFS authentication uses adfs's usernamemixed endpoint (version 1.3) which is available in ADFS 2.0+ and enabled by default. In case if you have troubles authenticating with adfs, check if under adfs server this particular endpoint is enabled - AD FS -> Service -> Endpoints:

Credential options:

• username - required string, your domain user name. Username can be provided in two forms: with domain and without domain. For example for user johnsmith@contoso-corp.com you need to provide johnsmith@contoso-corp.com as username option OR {username: 'johnsmith', domain: 'contoso', password: 'pass'}.

• password - required string, password

• domain - optional string, used when you are using short username form. The easiest way to know your current domain when you are inside corporation is to run echo %USERDOMAIN% in command line

• relyingParty - required string, this parameter may vary depending on your configuration. Relying party name you setup when configuring ADFS. For on-premise you can get the name of the relying party by running Get-SPTrustedIdentityTokenIssuer cmdlet. You may have many trusted token issuers in your farm, you need to find the one responsible for ADFS authentication and copy DefaultProviderRealm param:

  

• adfsUrl - required string, url to your adfs server

• adfsCookie - optional string, adfs cookie name. In most cases you can skip this parameter and default "FedAuth" will be used. But some organizations use custom cookie names for their ADFS configuration. In that case you can specify this custom cookie name, i.e. adfsCookie: 'FedAuth01'

Example:

{
  username: 'johnsmith@contoso-corp.com',
  password: 'sd46$fFF$',
  relyingParty: 'urn:sharepoint:portal',
  adfsUrl: 'https://adfs3'
}

OR

{
  username: 'johnsmith',
  domain: 'contoso',
  password: 'sd46$fFF$',
  relyingParty: 'urn:sharepoint:portal',
  adfsUrl: 'https://adfs3'
}

Resolving object:

{
  headers: {
    'Cookie': '<FedAuth authentication cookie>'
  }
}

Configuration required:

You need to have ADFS configured and working, usernamemixed endpoint (version 1.3) enabled on ADFS server.
Also make sure that on your SharePoint web application root site collection is created.

Sample using:

import * as spauth from 'node-sp-auth';
import * as request from 'request-promise';

spauth
  .getAuth('https://sp2013dev/sites/dev', {
    username: 'johnsmith@contoso-corp.com',
    password: '[password]',
    relyingParty: 'urn:sharepoint:portal',
    adfsUrl: 'https://adfs3'
  })
  .then(data => {
    let headers = data.headers;
    headers['Accept'] = 'application/json;odata=verbose';

    request.get({
      url: 'https://sp2013dev/sites/dev/_api/web',
      headers: headers,
      json: true
    }).then(response => {
      console.log(response.d.Title);
    });
  });