Official Node SDK for interacting with the WorkOS API
Installations
npm install @workos-inc/nodeDeveloper
Developer Guide
Module System
ESM
Min. Node Version
>=16
Typescript Support
No
Node Version
18.20.5
NPM Version
10.8.2
Statistics
120 Stars
1,082 Commits
30 Forks
17 Watching
49 Branches
55 Contributors
Updated on 28 Nov 2024
Languages
TypeScript (99.87%)
JavaScript (0.07%)
Shell (0.06%)
Total Downloads
Cumulative downloads
Total Downloads
17,032,945
Last day
-53.6%
55,493
Compared to previous day
Last week
-4.5%
521,864
Compared to previous week
Last month
6.4%
2,126,341
Compared to previous month
Last year
125.1%
9,903,304
Compared to previous year
Daily Downloads
Weekly Downloads
Monthly Downloads
Yearly Downloads
WorkOS Node.js Library
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 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:
1WORKOS_API_KEY="sk_1234"
Or, you can set it on your own before your application starts:
1import { WorkOS } from '@workos-inc/node'; 2 3const workos = new WorkOS('sk_1234');
SDK Versioning
For our SDKs WorkOS follows a Semantic Versioning (SemVer) 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 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
No vulnerabilities found.
Reason
all changesets reviewed
Reason
30 commit(s) and 0 issue activity found in the last 90 days -- score normalized to 10
Reason
no dangerous workflow patterns detected
Reason
no binaries found in the repo
Reason
0 existing vulnerabilities detected
Reason
license file detected
Details
- Info: project has a license file: LICENSE:0
- Info: FSF or OSI recognized license: MIT License: LICENSE:0
Reason
packaging workflow detected
Details
- Info: Project packages its releases by way of GitHub Actions.: .github/workflows/release.yml:15
Reason
detected GitHub workflow tokens with excessive permissions
Details
- Warn: no topLevel permission defined: .github/workflows/ci.yml:1
- Warn: no topLevel permission defined: .github/workflows/fix-latest.yml:1
- Warn: no topLevel permission defined: .github/workflows/release.yml:1
- Info: no jobLevel write permissions found
Reason
dependency not pinned by hash detected -- score normalized to 0
Details
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/ci.yml:21: update your workflow using https://app.stepsecurity.io/secureworkflow/workos/workos-node/ci.yml/main?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/ci.yml:22: update your workflow using https://app.stepsecurity.io/secureworkflow/workos/workos-node/ci.yml/main?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/fix-latest.yml:20: update your workflow using https://app.stepsecurity.io/secureworkflow/workos/workos-node/fix-latest.yml/main?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/fix-latest.yml:21: update your workflow using https://app.stepsecurity.io/secureworkflow/workos/workos-node/fix-latest.yml/main?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/release.yml:19: update your workflow using https://app.stepsecurity.io/secureworkflow/workos/workos-node/release.yml/main?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/release.yml:20: update your workflow using https://app.stepsecurity.io/secureworkflow/workos/workos-node/release.yml/main?enable=pin
- Warn: npmCommand not pinned by hash: .github/workflows/ci.yml:28
- Warn: npmCommand not pinned by hash: .github/workflows/fix-latest.yml:28
- Warn: npmCommand not pinned by hash: .github/workflows/release.yml:27
- Info: 0 out of 6 GitHub-owned GitHubAction dependencies pinned
- Info: 0 out of 3 npmCommand dependencies pinned
Reason
no effort to earn an OpenSSF best practices badge detected
Reason
security policy file not detected
Details
- Warn: no security policy file detected
- Warn: no security file to analyze
- Warn: no security file to analyze
- Warn: no security file to analyze
Reason
project is not fuzzed
Details
- Warn: no fuzzer integrations found
Reason
SAST tool is not run on all commits -- score normalized to 0
Details
- Warn: 0 commits out of 30 are checked with a SAST tool
Score
6.1
/10
Last Scanned on 2024-11-18
The Open Source Security Foundation is a cross-industry collaboration to improve the security of open source software (OSS). The Scorecard provides security health metrics for open source projects.
Learn More