Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/workos-inc/workos-node
Official Node SDK for interacting with the WorkOS API
https://github.com/workos-inc/workos-node
adfs audit-logs azure-active-directory directory-sync gsuite-saml-apps node-sdk okta saml scim sso sso-solution
Last synced: 13 days ago
JSON representation
Official Node SDK for interacting with the WorkOS API
- Host: GitHub
- URL: https://github.com/workos-inc/workos-node
- Owner: workos
- License: mit
- Created: 2019-06-13T16:03:28.000Z (over 5 years ago)
- Default Branch: main
- Last Pushed: 2025-01-02T14:43:00.000Z (25 days ago)
- Last Synced: 2025-01-06T10:32:34.890Z (21 days ago)
- Topics: adfs, audit-logs, azure-active-directory, directory-sync, gsuite-saml-apps, node-sdk, okta, saml, scim, sso, sso-solution
- Language: TypeScript
- Homepage: https://workos.com/docs/sdk/node
- Size: 11.6 MB
- Stars: 126
- Watchers: 18
- Forks: 31
- Open Issues: 25
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
- awesome-list - workos-node - inc | 30 | (TypeScript)
README
# WorkOS Node.js Library
[](https://github.com/workos/workos-node/actions/workflows/ci.yml)
The WorkOS library for Node.js provides convenient access to the WorkOS API from applications written in server-side JavaScript.
## Documentation
See the [API Reference](https://workos.com/docs/reference/client-libraries) for Node.js usage examples.
## Requirements
Node 16 or higher.
## Installation
Install the package with:
```
yarn add @workos-inc/node
```
## Configuration
To use the library you must provide an API key, located in the WorkOS dashboard, as an environment variable `WORKOS_API_KEY`:
```sh
WORKOS_API_KEY="sk_1234"
```
Or, you can set it on your own before your application starts:
```ts
import { WorkOS } from '@workos-inc/node';
const workos = new WorkOS('sk_1234');
```
## SDK Versioning
For our SDKs WorkOS follows a Semantic Versioning ([SemVer](https://semver.org/)) process where all releases will have a version X.Y.Z (like 1.0.0) pattern wherein Z would be a bug fix (e.g., 1.0.1), Y would be a minor release (1.1.0) and X would be a major release (2.0.0). We permit any breaking changes to only be released in major versions and strongly recommend reading changelogs before making any major version upgrades.
## Beta Releases
WorkOS has features in Beta that can be accessed via Beta releases. We would love for you to try these
and share feedback with us before these features reach general availability (GA). To install a Beta version,
please follow the [installation steps](#installation) above using the Beta release version.
> Note: there can be breaking changes between Beta versions. Therefore, we recommend pinning the package version to a
> specific version. This way you can install the same version each time without breaking changes unless you are
> intentionally looking for the latest Beta version.
We highly recommend keeping an eye on when the Beta feature you are interested in goes from Beta to stable so that you
can move to using the stable version.
## More Information
- [Single Sign-On Guide](https://workos.com/docs/sso/guide)
- [Directory Sync Guide](https://workos.com/docs/directory-sync/guide)
- [Admin Portal Guide](https://workos.com/docs/admin-portal/guide)
- [Magic Link Guide](https://workos.com/docs/magic-link/guide)
- [Domain Verification Guide](https://workos.com/docs/domain-verification/guide)