-
Notifications
You must be signed in to change notification settings - Fork 24
docs: add sandbox workload identity (IAM tokens) page #312
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.
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
Draft
mishushakov
wants to merge
1
commit into
main
Choose a base branch
from
document-pr-1606-changes
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Draft
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,64 @@ | ||
| --- | ||
| title: "Workload identity" | ||
| sidebarTitle: Workload identity | ||
| description: "Give sandbox workloads short-lived identity tokens instead of long-lived secrets." | ||
| --- | ||
|
|
||
| Workload identity lets code running in a sandbox prove who it is with short-lived identity tokens instead of long-lived credentials. | ||
| Rather than baking cloud API keys into a template or passing them as environment variables, you define named workload tokens when creating the sandbox. | ||
| 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. | ||
| </Note> | ||
|
|
||
| ## Configure | ||
|
|
||
| Pass the `iam` option when creating a sandbox. A non-empty `tokens` map enables workload identity for the sandbox. | ||
| Each entry maps a token name you choose to a token definition, which you can create with the `Secret` helper. | ||
|
|
||
| <CodeGroup> | ||
| ```js JavaScript & TypeScript | ||
| import { Sandbox, Secret } from 'e2b' | ||
|
|
||
| const sandbox = await Sandbox.create({ | ||
| iam: { | ||
| tokens: { | ||
| aws: Secret.iamToken({ | ||
| audience: 'sts.amazonaws.com', | ||
| tokenType: 'JWT-SVID', | ||
| }), | ||
| }, | ||
| }, | ||
| }) | ||
| ``` | ||
| ```python Python | ||
| from e2b import Sandbox, Secret | ||
|
|
||
| sandbox = Sandbox.create( | ||
| iam={ | ||
| "tokens": { | ||
| "aws": Secret.iam_token( | ||
| audience="sts.amazonaws.com", | ||
| token_type="JWT-SVID", | ||
| ), | ||
| }, | ||
| }, | ||
| ) | ||
| ``` | ||
| </CodeGroup> | ||
|
|
||
| You can also pass plain token definitions instead of using the `Secret` helper — `{ audience, tokenType }` objects in JavaScript, `{"audience": ..., "token_type": ...}` dicts in Python. | ||
|
|
||
| ## Token definitions | ||
|
|
||
| Each token definition has two fields: | ||
|
|
||
| | Field | Description | | ||
| |-------|-------------| | ||
| | `audience` | Required. The audience of the workload token — the identifier of the service that will verify it. Stored exactly as provided. | | ||
| | `tokenType` (JavaScript) / `token_type` (Python) | Required. The workload token type. `"JWT-SVID"` is the only type supported today; more types may be added later. | | ||
|
|
||
| Token names (the keys of the `tokens` map) are yours to choose and must not be empty. A sandbox can define up to **5** workload tokens. | ||
|
|
||
| Creating a sandbox without the `iam` option, or with an empty `tokens` map, leaves workload identity disabled. | ||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
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".
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.