feat: add custom token exchange support

Author: gyaneshgouraw-okta

EXAMPLES.md

@@ -99,6 +99,62 @@ const Posts = () => {
 export default Posts;
 ```
 
+## Custom token exchange
+
+Exchange an external subject token for Auth0 tokens using the token exchange flow (RFC 8693):
+
+```jsx
+import React, { useState } from 'react';
+import { useAuth0 } from '@auth0/auth0-react';
+
+const TokenExchange = () => {
+  const { exchangeToken } = useAuth0();
+  const [tokens, setTokens] = useState(null);
+  const [error, setError] = useState(null);
+
+  const handleExchange = async (externalToken) => {
+    try {
+      const tokenResponse = await exchangeToken({
+        subject_token: externalToken,
+        subject_token_type: 'urn:your-company:legacy-system-token',
+        authorizationParams: {
+          audience: 'https://api.example.com/',
+          scope: 'openid profile email',
+        },
+      });
+
+      setTokens(tokenResponse);
+      setError(null);
+
+      // Use the returned tokens
+      console.log('Access Token:', tokenResponse.access_token);
+      console.log('ID Token:', tokenResponse.id_token);
+    } catch (e) {
+      console.error('Token exchange failed:', e);
+      setError(e.message);
+    }
+  };
+
+  return (
+    <div>
+      <button onClick={() => handleExchange('your-external-token')}>
+        Exchange Token
+      </button>
+      {tokens && <div>Token exchange successful!</div>}
+      {error && <div>Error: {error}</div>}
+    </div>
+  );
+};
+
+export default TokenExchange;
+```
+
+**Important Notes:**
+- The `subject_token_type` must be a namespaced URI under your organization's control
+- The external token must be validated in Auth0 Actions using strong cryptographic verification
+- This method implements RFC 8693 token exchange grant type
+- The audience and scope can be provided through `authorizationParams` or will fall back to SDK defaults
+
 ## Protecting a route in a `react-router-dom v6` app
 
 We need to access the `useNavigate` hook so we can use `navigate` in `onRedirectCallback` to return us to our `returnUrl`.

__mocks__/@auth0/auth0-spa-js.tsx

@@ -8,6 +8,7 @@ const getTokenSilently = jest.fn();
 const getTokenWithPopup = jest.fn();
 const getUser = jest.fn();
 const getIdTokenClaims = jest.fn();
+const exchangeToken = jest.fn();
 const isAuthenticated = jest.fn(() => false);
 const loginWithPopup = jest.fn();
 const loginWithRedirect = jest.fn();
@@ -28,6 +29,7 @@ export const Auth0Client = jest.fn(() => {
     getTokenWithPopup,
     getUser,
     getIdTokenClaims,
+    exchangeToken,
     isAuthenticated,
     loginWithPopup,
     loginWithRedirect,

__tests__/auth-provider.test.tsx

@@ -880,6 +880,101 @@ describe('Auth0Provider', () => {
     });
   });
 
+  it('should provide an exchangeToken method', async () => {
+    const tokenResponse = {
+      access_token: '__test_access_token__',
+      id_token: '__test_id_token__',
+      token_type: 'Bearer',
+      expires_in: 86400,
+      scope: 'openid profile email',
+    };
+    clientMock.exchangeToken.mockResolvedValue(tokenResponse);
+    const wrapper = createWrapper();
+    const { result } = renderHook(
+      () => useContext(Auth0Context),
+      { wrapper }
+    );
+    await waitFor(() => {
+      expect(result.current.exchangeToken).toBeInstanceOf(Function);
+    });
+    let response;
+    await act(async () => {
+      response = await result.current.exchangeToken({
+        subject_token: '__test_token__',
+        subject_token_type: 'urn:test:token-type',
+        scope: 'openid profile email',
+      });
+    });
+    expect(clientMock.exchangeToken).toHaveBeenCalledWith({
+      subject_token: '__test_token__',
+      subject_token_type: 'urn:test:token-type',
+      scope: 'openid profile email',
+    });
+    expect(response).toStrictEqual(tokenResponse);
+  });
+
+  it('should handle errors when exchanging tokens', async () => {
+    clientMock.exchangeToken.mockRejectedValue(new Error('__test_error__'));
+    const wrapper = createWrapper();
+    const { result } = renderHook(
+      () => useContext(Auth0Context),
+      { wrapper }
+    );
+    await waitFor(() => {
+      expect(result.current.exchangeToken).toBeInstanceOf(Function);
+    });
+    await act(async () => {
+      await expect(
+        result.current.exchangeToken({
+          subject_token: '__test_token__',
+          subject_token_type: 'urn:test:token-type',
+        })
+      ).rejects.toThrow('__test_error__');
+    });
+    expect(clientMock.exchangeToken).toHaveBeenCalled();
+  });
+
+  it('should update auth state after successful token exchange', async () => {
+    const user = { name: '__test_user__' };
+    const tokenResponse = {
+      access_token: '__test_access_token__',
+      id_token: '__test_id_token__',
+      token_type: 'Bearer',
+      expires_in: 86400,
+    };
+    clientMock.exchangeToken.mockResolvedValue(tokenResponse);
+    clientMock.getUser.mockResolvedValue(user);
+    const wrapper = createWrapper();
+    const { result } = renderHook(
+      () => useContext(Auth0Context),
+      { wrapper }
+    );
+    await waitFor(() => {
+      expect(result.current.exchangeToken).toBeInstanceOf(Function);
+    });
+    await act(async () => {
+      await result.current.exchangeToken({
+        subject_token: '__test_token__',
+        subject_token_type: 'urn:test:token-type',
+      });
+    });
+    expect(clientMock.getUser).toHaveBeenCalled();
+    expect(result.current.user).toStrictEqual(user);
+  });
+
+  it('should memoize the exchangeToken method', async () => {
+    const wrapper = createWrapper();
+    const { result, rerender } = renderHook(
+      () => useContext(Auth0Context),
+      { wrapper }
+    );
+    await waitFor(() => {
+      const memoized = result.current.exchangeToken;
+      rerender();
+      expect(result.current.exchangeToken).toBe(memoized);
+    });
+  });
+
   it('should provide a handleRedirectCallback method', async () => {
     clientMock.handleRedirectCallback.mockResolvedValue({
       appState: { redirectUri: '/' },

src/auth0-context.tsx

@@ -11,7 +11,9 @@ import {
   RedirectLoginOptions as SPARedirectLoginOptions,
   type Auth0Client,
   RedirectConnectAccountOptions,
-  ConnectAccountRedirectResult
+  ConnectAccountRedirectResult,
+  CustomTokenExchangeOptions,
+  TokenEndpointResponse
 } from '@auth0/auth0-spa-js';
 import { createContext } from 'react';
 import { AuthState, initialAuthState } from './auth-state';
@@ -90,6 +92,35 @@ export interface Auth0ContextInterface<TUser extends User = User>
    */
   getIdTokenClaims: () => Promise<IdToken | undefined>;
 
+  /**
+   * ```js
+   * const tokenResponse = await exchangeToken({
+   *   subject_token: 'external_token_value',
+   *   subject_token_type: 'urn:acme:legacy-system-token',
+   *   scope: 'openid profile email'
+   * });
+   * ```
+   *
+   * Exchanges an external subject token for Auth0 tokens via a token exchange request.
+   *
+   * This method implements the token exchange grant as specified in RFC 8693.
+   * It performs a token exchange by sending a request to the `/oauth/token` endpoint
+   * with the external token and returns Auth0 tokens (access token, ID token, etc.).
+   *
+   * The request includes the following parameters:
+   * - `grant_type`: Hard-coded to "urn:ietf:params:oauth:grant-type:token-exchange"
+   * - `subject_token`: The external token to be exchanged
+   * - `subject_token_type`: A namespaced URI identifying the token type (must be under your organization's control)
+   * - `audience`: The target audience (falls back to the SDK's default audience if not provided)
+   * - `scope`: Space-separated list of scopes (merged with the SDK's default scopes)
+   *
+   * @param options - The options required to perform the token exchange
+   * @returns A promise that resolves to the token endpoint response containing Auth0 tokens
+   */
+  exchangeToken: (
+    options: CustomTokenExchangeOptions
+  ) => Promise<TokenEndpointResponse>;
+
   /**
    * ```js
    * await loginWithRedirect(options);
@@ -229,6 +260,7 @@ export const initialContext = {
   getAccessTokenSilently: stub,
   getAccessTokenWithPopup: stub,
   getIdTokenClaims: stub,
+  exchangeToken: stub,
   loginWithRedirect: stub,
   loginWithPopup: stub,
   connectAccountWithRedirect: stub,

src/auth0-provider.tsx

@@ -17,7 +17,9 @@ import {
   User,
   RedirectConnectAccountOptions,
   ConnectAccountRedirectResult,
-  ResponseType
+  ResponseType,
+  CustomTokenExchangeOptions,
+  TokenEndpointResponse
 } from '@auth0/auth0-spa-js';
 import Auth0Context, {
   Auth0ContextInterface,
@@ -277,6 +279,26 @@ const Auth0Provider = <TUser extends User = User>(opts: Auth0ProviderOptions<TUs
     [client]
   );
 
+  const exchangeToken = useCallback(
+    async (
+      options: CustomTokenExchangeOptions
+    ): Promise<TokenEndpointResponse> => {
+      let tokenResponse;
+      try {
+        tokenResponse = await client.exchangeToken(options);
+      } catch (error) {
+        throw tokenError(error);
+      } finally {
+        dispatch({
+          type: 'GET_ACCESS_TOKEN_COMPLETE',
+          user: await client.getUser(),
+        });
+      }
+      return tokenResponse;
+    },
+    [client]
+  );
+
   const handleRedirectCallback = useCallback(
     async (
       url?: string
@@ -321,6 +343,7 @@ const Auth0Provider = <TUser extends User = User>(opts: Auth0ProviderOptions<TUs
       getAccessTokenSilently,
       getAccessTokenWithPopup,
       getIdTokenClaims,
+      exchangeToken,
       loginWithRedirect,
       loginWithPopup,
       connectAccountWithRedirect,
@@ -336,6 +359,7 @@ const Auth0Provider = <TUser extends User = User>(opts: Auth0ProviderOptions<TUs
     getAccessTokenSilently,
     getAccessTokenWithPopup,
     getIdTokenClaims,
+    exchangeToken,
     loginWithRedirect,
     loginWithPopup,
     connectAccountWithRedirect,

src/index.tsx

@@ -43,6 +43,8 @@ export {
   RedirectConnectAccountOptions,
   ConnectAccountRedirectResult,
   ResponseType,
-  ConnectError
+  ConnectError,
+  CustomTokenExchangeOptions,
+  TokenEndpointResponse
 } from '@auth0/auth0-spa-js';
 export { OAuthError } from './errors';

src/use-auth0.tsx

@@ -14,6 +14,7 @@ import Auth0Context, { Auth0ContextInterface } from './auth0-context';
  *   getAccessTokenSilently,
  *   getAccessTokenWithPopup,
  *   getIdTokenClaims,
+ *   exchangeToken,
  *   loginWithRedirect,
  *   loginWithPopup,
  *   logout,