Module: oidc

Table of contents

Interfaces

• AwsCredentialsProviderInit

Functions

• awsCredentialsProvider
• getVercelOidcToken
• getVercelOidcTokenSync

Functions

awsCredentialsProvider

▸ awsCredentialsProvider(init): AwsCredentialIdentityProvider

Parameters

Returns

AwsCredentialIdentityProvider

Defined in

packages/functions/src/oidc/aws-credentials-provider.ts:70

getVercelOidcToken

▸ getVercelOidcToken(options?): Promise<string>

Gets the current OIDC token from the request context or the environment variable.

Do not cache this value, as it is subject to change in production!

This function is used to retrieve the OIDC token from the request context or the environment variable. It checks for the x-vercel-oidc-token header in the request context and falls back to the VERCEL_OIDC_TOKEN environment variable if the header is not present.

Unlike the getVercelOidcTokenSync function, this function will refresh the token if it is expired in a development environment.

Throws

If the x-vercel-oidc-token header is missing from the request context and the environment variable VERCEL_OIDC_TOKEN is not set. If the token is expired in a development environment, will also throw an error if the token cannot be refreshed: no CLI credentials are available, CLI credentials are expired, no project configuration is available or the token refresh request fails.

Example

// Using the OIDC token
getVercelOidcToken()
  .then(token => {
    console.log('OIDC Token:', token);
  })
  .catch(error => {
    console.error('Error:', error.message);
  });

Example

// Using the OIDC token with explicit team and project (supports IDs and slugs)
getVercelOidcToken({ team: 'my-team', project: 'my-project' })
  .then(token => {
    console.log('OIDC Token:', token);
  })
  .catch(error => {
    console.error('Error:', error.message);
  });

Parameters

Returns

Promise<string>

A promise that resolves to the OIDC token.

Defined in

packages/oidc/dist/get-vercel-oidc-token.d.ts:60

getVercelOidcTokenSync

▸ getVercelOidcTokenSync(): string

Gets the current OIDC token from the request context or the environment variable.

Do not cache this value, as it is subject to change in production!

This function is used to retrieve the OIDC token from the request context or the environment variable. It checks for the x-vercel-oidc-token header in the request context and falls back to the VERCEL_OIDC_TOKEN environment variable if the header is not present.

This function will not refresh the token if it is expired. For refreshing the token, use the @{link getVercelOidcToken} function.

Throws

If the x-vercel-oidc-token header is missing from the request context and the environment variable VERCEL_OIDC_TOKEN is not set.

Example

// Using the OIDC token
const token = getVercelOidcTokenSync();
console.log('OIDC Token:', token);

Returns

string

The OIDC token.

Defined in

packages/oidc/dist/get-vercel-oidc-token.d.ts:82