Skip to content

docs: add sandbox workload identity (IAM tokens) page#312

Draft
mishushakov wants to merge 1 commit into
mainfrom
document-pr-1606-changes
Draft

docs: add sandbox workload identity (IAM tokens) page#312
mishushakov wants to merge 1 commit into
mainfrom
document-pr-1606-changes

Conversation

@mishushakov

Copy link
Copy Markdown
Member

Documents the sandbox workload identity feature from e2b-dev/E2B#1606. Adds a new Workload identity page to the Sandbox group covering the iam option on Sandbox.create, the Secret.iamToken / Secret.iam_token helper, and the plain-object token form, with JS and Python examples. Also documents backend constraints verified in the infra code: JWT-SVID as the only supported token type, required audience, non-empty token names, a 5-token limit, and the per-team gating error. Runtime token delivery is intentionally not documented — it isn't implemented in the public spec yet.

🤖 Generated with Claude Code

Documents the new `iam` option on Sandbox.create and the Secret
iamToken/iam_token helper from e2b-dev/E2B#1606.

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
@cla-bot cla-bot Bot added the cla-signed label Jul 24, 2026
@cursor

cursor Bot commented Jul 24, 2026

Copy link
Copy Markdown

PR Summary

Low Risk
Documentation-only change with no runtime or API behavior modified in this repository.

Overview
Adds docs/sandbox/workload-identity.mdx and registers it in the Sandbox section of docs.json after secured access. The page explains the iam option on Sandbox.create, Secret.iamToken / Secret.iam_token, plain token objects, team gating, and limits (JWT-SVID, audience, five tokens, non-empty names). It does not document how workloads retrieve or use tokens inside the sandbox after creation, so the guide stops at configuration. No cross-links were added from other sandbox pages to this one.

Reviewed by Cursor Bugbot for commit 9614e54. Bugbot is set up for automated code reviews on this repo. Configure here.

@cursor cursor Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Cursor Bugbot has reviewed your changes and found 1 potential issue.

Fix All in Cursor

❌ Bugbot Autofix is OFF. To automatically fix reported issues with cloud agents, enable autofix in the Cursor dashboard.

Reviewed by Cursor Bugbot for commit 9614e54. Configure here.

Each token is scoped to an audience — the external service that will verify it, such as AWS STS — and the service can exchange the token for its own temporary credentials.

<Note>
Workload identity is currently available for selected teams. If it's not enabled for your team, sandbox creation with the `iam` option fails with `Sandbox IAM workload tokens are not available for your team.` — [contact us](/docs/support) to get access.

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Team used instead of project

Medium Severity

Prose uses "teams" / "your team" for the E2B organizational unit; user-facing docs use "project". The quoted API error string can keep "team".

Fix in Cursor Fix in Web

Triggered by learned rule: Use "project" not "team" for the organizational concept — but keep API identifiers unchanged

Reviewed by Cursor Bugbot for commit 9614e54. Configure here.

@mintlify

mintlify Bot commented Jul 24, 2026

Copy link
Copy Markdown
Contributor

Preview deployment for your docs. Learn more about Mintlify Previews.

Project Status Preview Updated (UTC)
e2b 🟢 Ready View Preview Jul 24, 2026, 5:36 PM

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant