Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
1 change: 1 addition & 0 deletions main/docs.json
Original file line number Diff line number Diff line change
Expand Up @@ -2047,6 +2047,7 @@
"docs/secure/tokens/token-vault/connected-accounts-for-token-vault",
"docs/secure/tokens/token-vault/refresh-token-exchange-with-token-vault",
"docs/secure/tokens/token-vault/access-token-exchange-with-token-vault",
"docs/secure/tokens/token-vault/privileged-worker-token-exchange-with-token-vault",
"docs/secure/tokens/token-vault/configure-token-vault"
]
}
Expand Down
9 changes: 9 additions & 0 deletions main/docs/secure/tokens/token-vault.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -79,6 +79,11 @@ Applications can access Token Vault using the following token exchanges:
<td>Exchanges an Auth0 access token for an external provider’s access token.</td>
<td>APIs or microservices that need to exchange access tokens they’ve received from other services or applications, such as a Single-Page Application (SPA).</td>
</tr>
<tr>
<td><a href="/docs/secure/tokens/token-vault/privileged-worker-token-exchange-with-token-vault">Privileged worker token exchange</a></td>
<td>Exchanges a signed JWT bearer token for an external provider’s access or refresh token.</td>
<td>Backend applications or service workers in service-to-service (M2M) flows.</td>
</tr>
</tbody>
</table>

Expand Down Expand Up @@ -106,6 +111,10 @@ To get started with Token Vault, read the following:
<td>How an application uses the access token exchange with Token Vault to call external APIs.</td>
</tr>
<tr>
<td><a href="/docs/secure/tokens/token-vault/privileged-worker-token-exchange-with-token-vault">Privileged Worker Token Exchange with Token Vault</a></td>
<td>How an application uses the privileged worker token exchange with Token Vault to call external APIs.</td>
</tr>
<tr>
<td><a href="/docs/secure/tokens/token-vault/configure-token-vault">Configure Token Vault</a></td>
<td>How to configure the Token Vault, including the token exchange.</td>
</tr>
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,206 @@
---
description: Learn how an application can access the Token Vault to exchange a JWT bearer token for an access or refresh token to call external APIs.
'og:image': https://cdn2.auth0.com/docs/1.14553.0/img/share-image.png
'og:title': Privileged Worker Token Exchange with Token Vault
'og:url': https://auth0.com/docs/
permalink: privileged-worker-token-exchange-with-token-vault
title: Privileged Worker Token Exchange with Token Vault
'twitter:description': Learn how an application can access the Token Vault to exchange a JWT bearer token for an access or refresh token to call external APIs.
'twitter:title': Privileged Worker Token Exchange with Token Vault
---

<Callout icon="file-lines" color="#0EA5E9" iconType="regular">
Privileged Worker Token Exchange with Token Vault is currently in Beta. To learn more about Auth0’s product release cycle, read [Product Release Stages](/docs/troubleshoot/product-lifecycle/product-release-stages). To participate in this program, contact [Auth0 Support](https://support.auth0.com/) or your Technical Account Manager.
</Callout>

Token Vault supports the Privileged Worker Token Exchange, which enables a client application to exchange a signed JWT (subject token) for an external provider’s access or refresh token (requested token).

After successful user authentication and authorization, a client application typically passes the user context, which contains the user's identity, permissions, and session state, as an access or refresh token to perform the token exchange with Token Vault. In service-to-service flows, a client application, such as a backend application or service worker, may need to access resources on the user’s behalf, but because the “user is not present” in an interactive session, the client application doesn’t have access to the user context.

In these service-to-service scenarios, the client application can generate a signed JWT bearer token and use it as the subject token to perform the token exchange and receive the necessary tokens to call external APIs. This means the client application can perform actions on the user’s behalf without an active user interaction or session.

To use the Privileged Worker Token Exchange with Token Vault, the client application must be a highly privileged client that can also request refresh tokens from external providers via Token Vault. It should authenticate with Token Vault using asymmetric cryptographic methods such as [Private Key JWT](/docs/get-started/authentication-and-authorization-flow/authenticate-with-private-key-jwt) assertion or [mutual TLS authentication](/docs/get-started/authentication-and-authorization-flow/authenticate-with-mtls).

## Prerequisites

Only certain types of clients can use the Privileged Worker Token Exchange with Token Vault:
- The client must be a first-party client, i.e. the `is_first_party property` is `true`.
- The client must be a confidential client with a valid authentication mechanism, i.e. the `token_endpoint_auth_method` property must not be set to `none`.
- The client must be OIDC conformant, i.e. the `oidc_conformant` must be `true`.

Before configuring Privileged Worker Token Exchange for your client application:
1. [Enable the Token Vault grant type](/docs/secure/tokens/token-vault/configure-token-vault#configure-application) for your client application.
2. Configure [Private Key JWT](/docs/get-started/authentication-and-authorization-flow/authenticate-with-private-key-jwt) or [mutual TLS authentication](/docs/get-started/authentication-and-authorization-flow/authenticate-with-mtls) for your client application.

## Configure client application

To configure the client application’s privileged access to Token Vault, you need to provide a public key that will be used to verify a signed JWT as the subject token.

Similar to [configuring JAR](/docs/get-started/applications/configure-jar#configure-jwt-secured-authorization-requests-jar), you can set the Token Vault privileged access public key when creating a new client:

```bash lines
POST https://{yourDomain}.auth0.com/api/v2/clients
Authorization: Bearer <YOUR_MANAGEMENT_API_ACCESS_TOKEN>
Content-Type: application/json
{
"name": "My App using JAR",
“grant_types”: [“urn:auth0:params:oauth:grant-type:token-exchange:federated-connection-access-token”],
“oidc_conformant”: true,
“is_first_party”: true,
“jwt_configuration”: {
“alg”: 'RS256',
},

"token_vault_privileged_access": {
"credentials": [{
"name": "My credential for Token Vault Privileged Access",
"credential_type": "public_key",
"pem": "<YOUR PEM FILE CONTENT>",
"alg": "RS256"
}]
},
}
```

You can also update an existing client with the Token Vault privileged access public key:

```bash lines
PATCH https://{yourDomain}.auth0.com/api/v2/clients/{yourClientId}
Authorization: Bearer <YOUR_MANAGEMENT_API_ACCESS_TOKEN>
Content-Type: application/json
{
"token_vault_privileged_access": {
"credentials": [{"id": "<YOUR CREDENTIAL ID>"}]
}
}
```

## Create signed JWT subject token

After [configuring your client application with the public key](#configure-client-application), you need to create the subject token that will be exchanged for an access token for an external API. The subject token is a JSON Web Token (JWT) with the necessary claims. It is signed with the private key.

The JWT has a standard format and claims, where:
- Header’s `typ` is `token-vault-req+jwt`
- Header’s `kid` is optional if you have only one public key configured
- Payload’s `sub` is the user ID for whom you want to get the token for
- Payload’s `aud` is your tenant host
- Payload’s `iss` is your client ID making the request

The following is an example JWT:

```json lines
{
alg: "RS256"
typ: "token-vault-req+jwt"
}
.
{
sub: "auth0|000012030101231",
aud: "https://{yourDomain}.auth0.com/",
iss: "<YOUR_CLIENT_ID>",
iat: 1758799540,
exp: 1758800540,
nbf: 1758799540
}
```

The following code sample is a script that generates a signed JWT subject token:

```tsx lines
import * as jwt from 'jsonwebtoken';
const privateKey = ‘-----BEGIN RSA PRIVATE KEY-----........’;
const subjectToken = jwt.sign(
{
iss: CLIENT_ID,
aud: 'https://' + TENANT_DOMAIN + '/',
sub: USER_ID,
},
privateKey,
{
algorithm: 'RS256',
header: {
typ: 'token-vault-req+jwt',
},
}
);
```

## Request token for external API

Once you have the signed JWT, you can make a request for the access token for the external API:

```bash lines
curl --request POST 'https://{yourDomain}/oauth/token' \
--header 'Content-Type: application/json' \
--data '{
"client_id": "<YOUR_CLIENT_ID>",
"client_secret": "<YOUR_CLIENT_SECRET>",
"subject_token": "<YOUR_SIGNED_JWT_BEARER>",
"grant_type": "urn:auth0:params:oauth:grant-type:token-exchange:federated-connection-access-token",
"subject_token_type": "urn:ietf:params:oauth:token-type:jwt",
"requested_token_type": "http://auth0.com/oauth/token-type/token-vault-access-token",
"connection": "google-oauth2"
}'
```

<table class="table"><thead>
<tr>
<th><strong>Parameter</strong></th>
<th><strong>Description</strong></th>
</tr>
</thead>
<tbody>
<tr>
<td><code>grant_type</code></td>
<td>The grant type. For Token Vault, set to <code>urn:auth0:params:oauth:grant-type:token-exchange:federated-connection-access-token</code></td>
</tr>
<tr>
<td><code>client_id</code></td>
<td>Client application ID</td>
</tr>
<tr>
<td><code>client_secret</code></td>
<td>Client secret. <strong>Note:</strong> For Privileged Worker Token Exchange, we recommend using Private Key JWT or mTLS authentication.</td>
</tr>
<tr>
<td><code>subject_token_type</code></td>
<td>Type of subject token. For Privileged Worker Token Exchange, set to JWT: <code>urn:ietf:params:oauth:token-type:jwt</code></td>
</tr>
<tr>
<td><code>subject_token</code></td>
<td>The signed JWT bearer token that the Auth0 Authorization Server validates to identify the user.</td>
</tr>
<tr>
<td><code>requested_token_type</code></td>
<td>The requested token type. For Privileged Worker Token Exchange, you can request an access or refresh token.</td>
</tr>
<tr>
<td><code>connection</code></td>
<td>The connection name, in this case, <code>google-oauth2</code>.</td>
</tr>
</tbody>
</table>

You should receive the access token stored in the Token Vault. You can similarly request the refresh token for the external API:

```bash lines
curl --request POST 'https://{yourDomain}/oauth/token' \
--header 'Content-Type: application/json' \
--data '{
"client_id": "<YOUR_CLIENT_ID>",
"client_secret": "<YOUR_CLIENT_SECRET>",
"subject_token": "<YOUR_SIGNED_JWT_BEARER>",
"grant_type": "urn:auth0:params:oauth:grant-type:token-exchange:federated-connection-access-token",
"subject_token_type": "urn:ietf:params:oauth:token-type:jwt",
"requested_token_type": "http://auth0.com/oauth/token-type/token-vault-refresh-token",
"connection": "google-oauth2"
}'
```