|
1 | | -#Stormpath is Joining Okta |
| 1 | +# Stormpath is Joining Okta |
| 2 | + |
2 | 3 | We are incredibly excited to announce that [Stormpath is joining forces with Okta](https://stormpath.com/blog/stormpaths-new-path?utm_source=github&utm_medium=readme&utm-campaign=okta-announcement). Please visit [the Migration FAQs](https://stormpath.com/oktaplusstormpath?utm_source=github&utm_medium=readme&utm-campaign=okta-announcement) for a detailed look at what this means for Stormpath users. |
3 | 4 |
|
4 | 5 | We're available to answer all questions at [[email protected]](mailto:[email protected]). |
5 | 6 |
|
6 | | -# Stormpath Node.js SDK |
7 | | - |
8 | | -[](https://npmjs.org/package/stormpath) |
9 | | -[](https://npmjs.org/package/stormpath) |
10 | | -[](https://travis-ci.org/stormpath/stormpath-sdk-node) |
11 | | -[](https://coveralls.io/github/stormpath/stormpath-sdk-node?branch=master) |
12 | | - |
13 | | -*A simple user management library for Node.js.* |
14 | | - |
15 | | -This library is a wrapper for the [Stormpath][] REST API. It is a collection of |
16 | | -methods that allow you to create, modify, and update resources in the REST API, |
17 | | -without having to manually make HTTP calls from your own code. |
18 | | - |
19 | | -[Stormpath][] is a User Management API that reduces development time with instant- |
20 | | -on, scalable user infrastructure. Stormpath's intuitive API and expert support |
21 | | -make it easy for developers to authenticate, manage and secure users and roles |
22 | | -in any application. |
23 | | - |
24 | | -This library provides low-level access to all of Stormpath's features, to name |
25 | | -a few: |
26 | | - |
27 | | -- Robust authentication and authorization. |
28 | | -- Schemaless user data. |
29 | | -- Social login with Facebook and Google OAuth. |
30 | | -- Generate and manage API keys for your service. |
31 | | -- Stateless authentication with JWTs. |
32 | | - |
33 | | -Because this library gives you basic low-level access to the REST API only, it |
34 | | -may not always be the best choice for the problem that you are trying to solve. |
35 | | -If you want to work with a more comprehensive framework integration, please see |
36 | | -the other libraries that are listed below. |
37 | | - |
38 | | - |
39 | | -## Documentation |
40 | | - |
41 | | -This library is fully documented with JsDoc, please visit the site here: |
42 | | -[Stormpath Node.js SDK Documentation][] |
43 | | - |
44 | | - |
45 | | -## Install |
46 | | - |
47 | | -```bash |
48 | | -npm install stormpath |
49 | | -``` |
50 | | - |
51 | | - |
52 | | -## Usage |
53 | | - |
54 | | -Everything starts with a [Client][] instance, which you create like so: |
55 | | - |
56 | | -```javascript |
57 | | -// Assumes API keys are in environment variables, or stormpath.yaml |
58 | | - |
59 | | -var stormpath = require('stormpath'); |
60 | | - |
61 | | -var client = new stormpath.Client(); |
62 | | -``` |
63 | | - |
64 | | -With a [Client][] instance, you can do many operations, like fetching all of the |
65 | | -accounts in your Stormpath Tenant: |
66 | | - |
67 | | -```javascript |
68 | | -// Fetch all the accounts in my Stormpath Tenant |
69 | | - |
70 | | -client.getAccounts(function(err, accountsCollection) { |
71 | | - accountsCollection.each(function(account, next) { |
72 | | - console.log(account); |
73 | | - next(); |
74 | | - }); |
75 | | -}); |
76 | | -``` |
77 | | - |
78 | | - |
79 | | -## Other Libraries |
80 | | - |
81 | | -This library is a low-level wrapper for the [Stormpath][] REST API. We also |
82 | | -provide high-level libraries for popular frameworks, these libraries provide |
83 | | -default views for login and registration, as well as many other features for |
84 | | -adding authentication and authorization to your full-stack web or mobile |
85 | | -application. |
86 | | - |
87 | | -- [Express-Stormpath][] - A deep integration with Express that will add default |
88 | | - view for authentication, and provide a JSON API for front-end and mobile |
89 | | - clients to use for authentication. |
90 | | - |
91 | | -- [Stormpath Angular SDK][] - This library provides default login and registration |
92 | | - views in your Angular application, and communicates with [Express-Stormpath][] |
93 | | - via its JSON API to authenticate the user, and tell Angular about the logged-in |
94 | | - user. This library can be used with other back-end frameworks, for more |
95 | | - integrations see https://docs.stormpath.com |
96 | | - |
97 | | -- [Stormpath React SDK][] - This library provides routes and components for |
98 | | - React that will allow you to solve common user management tasks using Stormpath, |
99 | | - such as login and signup. It communicates with [Express-Stormpath][] via |
100 | | - its JSON API to authenticate the user and provide user context to your React |
101 | | - application. This library can be used with other back-end frameworks, for more |
102 | | - integrations see https://docs.stormpath.com |
103 | | - |
104 | | - |
105 | | -## Tutorials |
106 | | - |
107 | | -These guides will walk you through the creation of a full-stack JavaScript |
108 | | -application that uses Node.js: |
109 | | - |
110 | | -- [API Key Management for Node – A Sample App](https://stormpath.com/blog/easy-api-key-management-for-node-a-sample-app-2) |
111 | | -- [Build an API Service with Oauth2 Authentication, using Restify and Stormpath](https://stormpath.com/blog/build-api-restify-stormpath) |
112 | | -- [Build an app with AngularJS, Node.js and Stormpath in 15 minutes](https://stormpath.com/blog/angular-node-15-minutes) |
113 | | -- [Build a React.js Application with User Authentication](https://stormpath.com/blog/build-a-react-app-with-user-authentication) |
114 | | -- [Build a REST API for Your Mobile Apps using Node.js](https://stormpath.com/blog/tutorial-build-rest-api-mobile-apps-using-node-js) |
115 | | -- [Build a Webapp with Node, Express, Bootstrap & Stormpath](https://stormpath.com/blog/build-nodejs-express-stormpath-app/) |
116 | | -- [Deploy Stormpath on Heroku with Express.js](https://github.com/stormpath/stormpath-heroku-express-sample) |
117 | | - |
118 | | - |
119 | | -## Support |
120 | | - |
121 | | -We're here to help if you get stuck. There are several ways that you an get in |
122 | | -touch with a member of our team: |
123 | | - |
124 | | - |
125 | | -* Open a Github Issue on this repository. |
126 | | -* Join us on our Slack channel: [https://talkstormpath.shipit.xyz/](https://talkstormpath.shipit.xyz/) |
127 | | - |
128 | | -[Stormpath AngularJS SDK]: https://github.com/stormpath/stormpath-sdk-angularjs |
129 | | -[Stormpath Product Guide]: https://docs.stormpath.com/rest/product-guide/latest/ |
130 | | -[Stormpath React SDK]: https://github.com/stormpath/stormpath-sdk-react |
131 | | -[express-stormpath]: https://docs.stormpath.com/nodejs/express/latest/ |
| 7 | +## What does this mean for developers who are using this library? |
132 | 8 |
|
| 9 | +This library is not being patched to work with Okta. If you are using this library, you should consider using the new [Okta Node SDK][] or manually integrating with an HTTP client. Please see the [Okta API reference][] for more information about the API. |
133 | 10 |
|
134 | | -## Copyright |
| 11 | +If you are using [Express-Stormpath][], that library is depending on the [okta branch] in this library. That branch is being maintained for [Express-Stormpath][] only. Using this branch directly is not supported. |
135 | 12 |
|
136 | | -Copyright © 2015 Stormpath, Inc. and contributors. |
| 13 | +## README |
137 | 14 |
|
138 | | -This project is open-source via the [Apache 2.0 License](http://www.apache.org/licenses/LICENSE-2.0). |
| 15 | +If you are actively using this library, you can find the readme in [OLD-README.md](OLD-README.md). |
| 16 | +It is not possible to register for new Stormpath tenants at this time, so you must |
| 17 | +already have a Stormpath tenant if you wish to use this library during the migration |
| 18 | +period. |
139 | 19 |
|
140 | | -[Client]: https://docs.stormpath.com/nodejs/api/client |
141 | | -[Express-Stormpath]: https://github.com/stormpath/stormpath-express |
142 | | -[Stormpath]: https://stormpath.com |
143 | | -[Stormpath Angular SDK]: https://github.com/stormpath/stormpath-sdk-angularjs |
144 | | -[Stormpath Node.js SDK Documentation]: https://docs.stormpath.com/nodejs/jsdoc/ |
145 | | -[Stormpath React SDK]: https://github.com/stormpath/stormpath-sdk-react |
| 20 | +[Express-Stormpath]: https://github.com/stormpath/express-stormpath |
| 21 | +[okta branch]: https://github.com/stormpath/stormpath-sdk-node/tree/okta |
| 22 | +[Okta API reference]: https://okta.github.io/docs/api/resources/apps.html |
| 23 | +[Okta Node SDK]: https://github.com/okta/okta-sdk-nodejs |
0 commit comments