Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/corbado/corbado-nodejs
Add passkeys to your Node.js application with the Corbado Node.js SDK.
https://github.com/corbado/corbado-nodejs
biometric corbado corbado-sdk express faceid fido fido2 nodejs passkey passkeys sdk touchid webauthn
Last synced: 6 days ago
JSON representation
Add passkeys to your Node.js application with the Corbado Node.js SDK.
- Host: GitHub
- URL: https://github.com/corbado/corbado-nodejs
- Owner: corbado
- License: mit
- Created: 2022-09-06T08:42:28.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2024-10-17T12:02:52.000Z (3 months ago)
- Last Synced: 2025-01-08T05:28:28.529Z (13 days ago)
- Topics: biometric, corbado, corbado-sdk, express, faceid, fido, fido2, nodejs, passkey, passkeys, sdk, touchid, webauthn
- Language: TypeScript
- Homepage: https://www.corbado.com/passkeys/node-js
- Size: 536 KB
- Stars: 35
- Watchers: 4
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Corbado Node.js SDK
[](./LICENSE)
[](https://nolleh.gitcorbado/corbado-nodejs/badges/coverage-jest%20coverage.svg?raw=true)
[](https://codecov.io/gh/corbado/corbado-nodejs)
[](https://apireference.cloud.corbado.io/backendapi-v2/)
[](https://join.slack.com/t/corbado/shared_invite/zt-1b7867yz8-V~Xr~ngmSGbt7IA~g16ZsQ)
The [Corbado](https://www.corbado.com) Node SDK provides convenient access to the [Corbado Backend API](https://apireference.cloud.corbado.io/backendapi-v2/) from applications written in Node.js.
:warning: The Corbado Node.js SDK is commonly referred to as a private client, specifically designed for usage within closed backend applications. This particular SDK should exclusively be utilized in such environments, as it is crucial to ensure that the API secret remains strictly confidential and is never shared.
:rocket: [Getting started](#rocket-getting-started) | :hammer_and_wrench: [Installation](#installation) | :books: [Advanced](#books-advanced) | :speech_balloon: [Support & Feedback](#speech_balloon-support--feedback)
## :rocket: Getting started
### Requirements
- Node.js 8 or higher.
## Installation
Use the following command to install the Corbado Node.js SDK:
```bash
npm install @corbado/node-sdk
```
## Usage
To create a Node.js SDK instance you need to provide your `Project ID` and `API secret` which can be found at the [Developer Panel](https://app.corbado.com).
### ES5:
```JavaScript
const Corbado = require('@corbado/node-sdk');
const projectID = process.env.CORBADO_PROJECT_ID;
const apiSecret = process.env.CORBADO_API_SECRET;
const frontendAPI = process.env.CORBADO_FRONTEND_API;
const backendAPI = process.env.CORBADO_BACKEND_API;
const config = new Corbado.Config(projectID, apiSecret, frontendAPI, backendAPI);
const sdk = new Corbado.SDK(config);
```
### ES6:
```JavaScript
import {SDK, Config} from '@corbado/node-sdk';
const projectID = process.env.CORBADO_PROJECT_ID;
const apiSecret = process.env.CORBADO_API_SECRET;
const frontendAPI = process.env.CORBADO_FRONTEND_API;
const backendAPI = process.env.CORBADO_BACKEND_API;
const config = new Config(projectID, apiSecret, frontendAPI, backendAPI);
const sdk = new SDK(config);
```
### Examples
A list of examples can be found in the integration tests [here](tests/integration).
### Services
The Corbado Node.js SDK provides the following services:
- `sessions` for managing sessions ([examples](tests/unit/session.test.ts))
- `identifiers` for managing identifiers ([examples](tests/integration/services/identifier.test.ts))
- `users` for managing users ([examples](tests/integration/services/user.test.ts))
To use a specific service, such as `sessions`, invoke it as shown below:
```JavaScript
corbado.sessions().validateToken(req);
```
## :books: Advanced
### Error handling
The Corbado Node.js SDK throws exceptions for all errors. The following errors are thrown:
- `BaseError` for failed assertions and configuration errors (client side)
- `ServerError` for server errors (server side)
If the Backend API returns a HTTP status code other than 200, the Corbado Node.js SDK throws a `ServerError`. The `ServerError`class provides convenient methods to access all important data:
```javascript
try {
// Try to get non-existing user with ID 'usr-123456789'
const user = sdk.users().get('usr-123456789');
} catch (error: ServerError) {
// Show HTTP status code (404 in this case)
console.log(error.getHttpStatusCode());
// Show request ID (can be used in developer panel to look up the full request
// and response, see https://app.corbado.com/app/logs/requests)
console.log(error.getRequestID());
// Show full request data
console.log(error.getRequestData());
// Show runtime of request in seconds (server side)
console.log(error.getRuntime());
// Show validation error messages (server side validation in case of HTTP
// status code 400 (Bad Request))
console.log(error.getValidationMessages());
// Show full error data
console.log(error.getError());
}
```
## :speech_balloon: Support & Feedback
### Report an issue
If you encounter any bugs or have suggestions, please [open an issue](https://github.com/corbado/corbado-nodejs/issues/new).
### Slack channel
Join our Slack channel to discuss questions or ideas with the Corbado team and other developers.
[](https://join.slack.com/t/corbado/shared_invite/zt-1b7867yz8-V~Xr~ngmSGbt7IA~g16ZsQ)
### Email
You can also reach out to us via email at [email protected].
### Vulnerability reporting
Please report suspected security vulnerabilities in private to [email protected]. Please do NOT create publicly viewable issues for suspected security vulnerabilities.