# stormpath

> Official Stormpath SDK for Node.js

Latest version **0.20.1** (published 2017-02-04) · Apache-2.0 license · 0 weekly downloads

> **Deprecated.** This package is deprecated.

## Install

```sh
npm install stormpath
pnpm add stormpath
yarn add stormpath
bun add stormpath
```

## Health

**Score 10/100 (F)** — status: deprecated.

Negative: deprecated.

## Facts

| | |
|---|---|
| Version | 0.20.1 |
| Published | 2017-02-04 |
| First published | 2013-06-17 |
| Weekly downloads | 0 |
| License | Apache-2.0 |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 14 |
| Known vulnerabilities | 0 (+10 in 8 direct dependencies) |
| Install scripts | no |
| GitHub stars | 90 |
| Author | Stormpath, Inc. |
| Maintainers | lhazlewood, rdegges, robertjd, timothyej, typerandom |
| Keywords | stormpath, api, wrapper, sdk, client, user, user management, user login, identity, identity management, account, account login, login, authentication, authorization, access control, password, password hash |

## Links

- npm: https://www.npmjs.com/package/stormpath
- Repository: https://github.com/stormpath/stormpath-sdk-node
- Issues: https://github.com/stormpath/stormpath-sdk-node/issues
- npm.io page: https://npm.io/package/stormpath

## Dependencies (14)

- [njwt](https://npm.io/package/njwt.md) ^0.4.0
- [uuid](https://npm.io/package/uuid.md) ^3.0.0
- [async](https://npm.io/package/async.md) ~1.5.2
- [redis](https://npm.io/package/redis.md) ~2.6.2
- [xtend](https://npm.io/package/xtend.md) ^4.0.1
- [moment](https://npm.io/package/moment.md) ^2.15.2
- [request](https://npm.io/package/request.md) ~2.74.0
- [memcached](https://npm.io/package/memcached.md) ~2.2.2
- [jwt-simple](https://npm.io/package/jwt-simple.md) ~0.4.0
- [underscore](https://npm.io/package/underscore.md) ~1.5.2
- [deep-extend](https://npm.io/package/deep-extend.md) ^0.4.1
- [stormpath-config](https://npm.io/package/stormpath-config.md) 0.0.27
- [properties-parser](https://npm.io/package/properties-parser.md) ~0.3.1
- [underscore.string](https://npm.io/package/underscore.string.md) ~3.2.3

## Alternatives

- [@clerk/clerk-expo](https://npm.io/package/@clerk/clerk-expo.md) — 133.6K weekly downloads
- [@pothos/plugin-authz](https://npm.io/package/@pothos/plugin-authz.md) — 12.4K weekly downloads
- [@bounded-sh/client](https://npm.io/package/@bounded-sh/client.md) — 3.2K weekly downloads
- [@luigi-project/plugin-auth-oauth2](https://npm.io/package/@luigi-project/plugin-auth-oauth2.md) — 2.3K weekly downloads
- [@nocobase/plugin-verification](https://npm.io/package/@nocobase/plugin-verification.md) — 2.0K weekly downloads

## Recent versions

- 0.20.1 (latest) — 2017-02-04
- 0.20.0 — 2017-01-24
- 0.19.2 — 2017-01-24
- 0.19.1 — 2017-01-16
- 0.19.0 — 2016-11-21
- 0.18.5 — 2016-08-11
- 0.18.4 — 2016-07-20
- 0.18.3 — 2016-06-23
- 0.18.2 — 2016-03-25
- 0.18.1 — 2016-03-24
- 0.18.0 — 2016-03-14
- 0.17.5 — 2016-03-03
- 0.17.4 — 2016-02-22
- 0.17.3 — 2016-02-19
- 0.17.2 — 2016-02-19
- … 52 more at https://npm.io/package/stormpath/versions

## README

# Stormpath Node.js SDK

[![NPM Version](https://img.shields.io/npm/v/stormpath.svg?style=flat)](https://npmjs.org/package/stormpath)
[![NPM Downloads](http://img.shields.io/npm/dm/stormpath.svg?style=flat)](https://npmjs.org/package/stormpath)
[![Build Status](https://travis-ci.org/stormpath/stormpath-sdk-node.svg?branch=master)](https://travis-ci.org/stormpath/stormpath-sdk-node)
[![Coverage Status](https://coveralls.io/repos/stormpath/stormpath-sdk-node/badge.svg?branch=master&service=github)](https://coveralls.io/github/stormpath/stormpath-sdk-node?branch=master)

*A simple user management library for Node.js.*

This library is a wrapper for the [Stormpath][] REST API.  It is a collection of
methods that allow you to create, modify, and update resources in the REST API,
without having to manually make HTTP calls from your own code.

[Stormpath][] is a User Management API that reduces development time with instant-
on, scalable user infrastructure. Stormpath's intuitive API and expert support
make it easy for developers to authenticate, manage and secure users and roles
in any application.

This library provides low-level access to all of Stormpath's features, to name
a few:

- Robust authentication and authorization.
- Schemaless user data.
- Social login with Facebook and Google OAuth.
- Generate and manage API keys for your service.
- Stateless authentication with JWTs.

Because this library gives you basic low-level access to the REST API only, it
may not always be the best choice for the problem that you are trying to solve.
If you want to work with a more comprehensive framework integration, please see
the other libraries that are listed below.


## Documentation

This library is fully documented with JsDoc, please visit the site here:
[Stormpath Node.js SDK Documentation][]


## Install

```bash
npm install stormpath
```


## Usage

Everything starts with a [Client][] instance, which you create like so:

```javascript
// Assumes API keys are in environment variables, or stormpath.yaml

var stormpath = require('stormpath');

var client = new stormpath.Client();
```

With a [Client][] instance, you can do many operations, like fetching all of the
accounts in your Stormpath Tenant:

```javascript
// Fetch all the accounts in my Stormpath Tenant

client.getAccounts(function(err, accountsCollection) {
  accountsCollection.each(function(account, next) {
    console.log(account);
    next();
  });
});
```


## Other Libraries

This library is a low-level wrapper for the [Stormpath][] REST API.  We also
provide high-level libraries for popular frameworks, these libraries provide
default views for login and registration, as well as many other features for
adding authentication and authorization to your full-stack web or mobile
application.

- [Express-Stormpath][] - A deep integration with Express that will add default
  view for authentication, and provide a JSON API for front-end and mobile
  clients to use for authentication.

- [Stormpath Angular SDK][] - This library provides default login and registration
  views in your Angular application, and communicates with [Express-Stormpath][]
  via its JSON API to authenticate the user, and tell Angular about the logged-in
  user.  This library can be used with other back-end frameworks, for more
  integrations see https://docs.stormpath.com

- [Stormpath React SDK][] - This library provides routes and components for
  React that will allow you to solve common user management tasks using Stormpath,
  such as login and signup.  It communicates with [Express-Stormpath][] via
  its JSON API to authenticate the user and provide user context to your React
  application.  This library can be used with other back-end frameworks, for more
  integrations see https://docs.stormpath.com


## Tutorials

These guides will walk you through the creation of a full-stack JavaScript
application that uses Node.js:

- [API Key Management for Node – A Sample App](https://stormpath.com/blog/easy-api-key-management-for-node-a-sample-app-2)
- [Build an API Service with Oauth2 Authentication, using Restify and Stormpath](https://stormpath.com/blog/build-api-restify-stormpath)
- [Build an app with AngularJS, Node.js and Stormpath in 15 minutes](https://stormpath.com/blog/angular-node-15-minutes)
- [Build a React.js Application with User Authentication](https://stormpath.com/blog/build-a-react-app-with-user-authentication)
- [Build a REST API for Your Mobile Apps using Node.js](https://stormpath.com/blog/tutorial-build-rest-api-mobile-apps-using-node-js)
- [Build a Webapp with Node, Express, Bootstrap & Stormpath](https://stormpath.com/blog/build-nodejs-express-stormpath-app/)
- [Deploy Stormpath on Heroku with Express.js](https://github.com/stormpath/stormpath-heroku-express-sample)


## Support

We're here to help if you get stuck.  There are several ways that you an get in
touch with a member of our team:

* Send an email to [support@stormpath.com](mailto:support@stormpath.com)
* Open a Github Issue on this repository.
* Join us on our Slack channel: [https://talkstormpath.shipit.xyz/](https://talkstormpath.shipit.xyz/)

[Stormpath AngularJS SDK]: https://github.com/stormpath/stormpath-sdk-angularjs
[Stormpath Product Guide]: https://docs.stormpath.com/rest/product-guide/latest/
[Stormpath React SDK]: https://github.com/stormpath/stormpath-sdk-react
[express-stormpath]: https://docs.stormpath.com/nodejs/express/latest/


## Copyright

Copyright © 2015 Stormpath, Inc. and contributors.

This project is open-source via the [Apache 2.0 License](http://www.apache.org/licenses/LICENSE-2.0).

[Client]: https://docs.stormpath.com/nodejs/api/client
[Express-Stormpath]: https://github.com/stormpath/stormpath-express
[Stormpath]: https://stormpath.com
[Stormpath Angular SDK]: https://github.com/stormpath/stormpath-sdk-angularjs
[Stormpath Node.js SDK Documentation]: https://docs.stormpath.com/nodejs/jsdoc/
[Stormpath React SDK]: https://github.com/stormpath/stormpath-sdk-react

---
_Source: https://npm.io/package/stormpath · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._