Skip to content

[Docs] Update OAuth encryption README #82

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
ColinGreybosh merged 1 commit into from
Sep 17, 2025
Merged

[Docs] Update OAuth encryption README #82

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 7 additions & 1 deletion packages/node-embed-sdk/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,13 @@ pnpm add @sigmacomputing/node-embed-sdk

### Token Encryption and Decryption

The SDK provides utilities for encrypting and decrypting OAuth tokens using AES-256-GCM encryption:
The SDK provides utilities for encrypting and decrypting OAuth tokens using AES-256-GCM encryption.

See our documentation on [embedding with JWTS](https://help.sigmacomputing.com/docs/create-an-embed-api-with-json-web-tokens) for more information.

Sigma expects you to encrypt OAuth tokens using the same embed secret used to sign the embed.

#### Example Usage

```typescript
import { encrypt, decrypt } from '@sigmacomputing/node-embed-sdk';
Expand Down