node-sp-auth allows you to perform SharePoint unattended (without user interaction) http authentication with nodejs using different authentication techniques.
node-sp-auth also takes care about caching authentication data for performance (no need for you to think about how long authentication will be available, that's a task for
node-sp-auth, as soon as authentication will be expired,
node-sp-auth will renew it internally).
Wiki contains detailed steps you need to perform in order to use any of authentication options as well as sample using.
npm install node-sp-auth --save-dev
;;//get auth optionsspauth;
Promise resolving into object with following properties:
headers- http headers (normally contain
Authorizationheader, may contain any other heraders as well)
options- any additional options you may need to include for succesful request. For example, in case of on premise user credentials authentication, you need to set
agentproperty on corresponding http client
url- required, string, url to SharePoint site,
credentialOptions- optional, object in a form of key-value. Each authentication option requires predefined credential object, depending on authentication type. Based on credentials provided,
node-sp-authautomatically determines which authentication strategy to use (strategies listed in the top of the readme file).
Possible values for
credentialOptions (depending on authentication strategy):
SharePoint on premise (2013, 2016):
ADFS user credentials:
On demand authentication
ondemand = true,
no authentication - do not provide any authentication data at all, like
spauth.getAuth(url).then(...). In that case
node-sp-auth will ask you for the site url and credentials. You will have to select any of the credential options listed above. Credentials will be stored in a user folder in an encrypted manner.
Credits: Andrew Koltyakov @koltyakov and his awesome node-sp-auth-config
Please, use Wiki to see how you can configure your environment in order to use any of this authentication options.
I recommend using VS Code for development. Repository already contains some settings for VS Code editor.
Before creating Pull Request you need to create an appropriate issue and reference it from PR.
git clone https://github.com/s-KaiNet/node-sp-auth.git
npm run build- runs linting and typescript compilation
npm run dev- setup watchers and automatically runs typescript compilation, tslint and tests when you save files
config.tswith appropriate values (urls, credentials).
npm run test:integration.