Skip to main content

OIDC

vercel.oidc retrieves and decodes Vercel OIDC tokens.

Async Token Lookup

from vercel.oidc import decode_oidc_payload
from vercel.headers import set_headers
from vercel.oidc.aio import get_vercel_oidc_token


async def main() -> None:
    token = await get_vercel_oidc_token()
    payload = decode_oidc_payload(token)
    project_id = payload.get("project_id")

Token lookup prefers the x-vercel-oidc-token request header registered with vercel.headers.set_headers(), then VERCEL_OIDC_TOKEN. The compatibility alias vercel.oidc.set_headers() updates the same header context. In local development, you can load a short-lived token dynamically:

VERCEL_OIDC_TOKEN=$(vc project token some-project) some-command

Use vercel.oidc.get_vercel_oidc_token() for synchronous code.

Verification

Requires the verify extra, which adds pyjwt[crypto]:

pip install "vercel-oidc[verify]"
from vercel.oidc import extract_bearer_token, verify_vercel_oidc_token

claims = verify_vercel_oidc_token(extract_bearer_token(request.headers))

Verification allows only RS256, resolves the signing key by kid from Vercel's JWKS, and pins the issuer to Vercel's OIDC service, which mints both https://oidc.vercel.com and the team-scoped https://oidc.vercel.com/<team>. It fails closed: when the expected project or environment cannot be resolved from the arguments, VERCEL_PROJECT_ID, or VERCEL_TARGET_ENV/VERCEL_ENV, every token is rejected. vercel.oidc.aio.verify_vercel_oidc_token() is the async twin.

Token Identity

A token is a signature over an identity plus an expiry, so one identity is issued many tokens over time. To key client-side state on the identity rather than on the token, use:

from vercel.oidc import resolve_vercel_oidc_token_identity

identity = resolve_vercel_oidc_token_identity(token)  # stable across a refresh

The token is verified first — signature, issuer and expiry — and only then are its identity claims reduced to an opaque digest that carries no credential and is safe to log.

What it does not do is authorize: it returns no claims and does not check the project, environment, owner or audience. Use verify_vercel_oidc_token() for that.

Metadata

Release files for vercel-oidc 0.8.1

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for vercel-oidc 0.8.1
File Size Uploaded
vercel_oidc-0.8.1.tar.gz 16.1 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for vercel-oidc 0.8.1
File Interpreter ABI Platform
vercel_oidc-0.8.1-py3-none-any.whl Python 3 none any Details

Total release size: 32.1 kB

Release files / vercel_oidc-0.8.1.tar.gz

Download URL vercel_oidc-0.8.1.tar.gz
Size 16.1 kB
Tags Source
SHA-256 checksum
How to use checksums
2cbcaf7d94b87c25e9772bc4aa3a7e25d2b11d639a6818b0905abe95728946c9
BLAKE2b-256 checksum
How to use checksums
4f96e8ca9616c4fd0d140dcfe6d23722d9402ad33b13a123281037470d44ad3e
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via uv/0.12.10 {"installer":{"name":"uv","version":"0.12.10","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}

Release files / vercel_oidc-0.8.1-py3-none-any.whl

Download URL vercel_oidc-0.8.1-py3-none-any.whl
Size 16.0 kB
Tags Python 3
SHA-256 checksum
How to use checksums
292752426d2f59e254299df46c45122d77d2935bad7bca63df47f7d744c29296
BLAKE2b-256 checksum
How to use checksums
5bbd884e9715b434e620bd5f78b99ef55261b658b98bd62e436d6e510acfc6a2
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via uv/0.12.10 {"installer":{"name":"uv","version":"0.12.10","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}

Release history Release notifications | RSS feed

0.9.0

2 release files

This release

0.8.1 This release

2 release files

0.8.0

2 release files

0.7.1

2 release files

0.7.0

2 release files

0.6.0

2 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page