@auth0/auth0-spa-js 2.10.0 → 2.11.0

package/dist/typings/Auth0Client.d.ts

@@ -233,6 +233,8 @@ export declare class Auth0Client {
      * - `scope`: A unique set of scopes, generated by merging the scopes supplied in the options
      *            with the SDK’s default scopes.
      * - `audience`: The target audience from the options, with fallback to the SDK's authorization configuration.
+     * - `organization`: Optional organization ID or name for authenticating the user in an organization context.
+     *                   When provided, the organization ID will be present in the access token payload.
      *
      * **Example Usage:**
      *
@@ -241,13 +243,15 @@ export declare class Auth0Client {
      * const options: CustomTokenExchangeOptions = {
      *   subject_token: 'eyJhbGciOiJIUzI1NiIsInR5cCI6Ikp...',
      *   subject_token_type: 'urn:acme:legacy-system-token',
-     *   scope: "openid profile"
+     *   scope: "openid profile",
+     *   organization: "org_12345"
      * };
      *
      * // Exchange the external token for Auth0 tokens
      * try {
      *   const tokenResponse = await instance.exchangeToken(options);
      *   // Use tokenResponse.access_token, tokenResponse.id_token, etc.
+     *   // The organization ID will be present in the access token payload
      * } catch (error) {
      *   // Handle token exchange error
      * }

package/dist/typings/TokenExchange.d.ts

@@ -53,6 +53,12 @@ export type CustomTokenExchangeOptions = {
      * "openid profile email read:data write:data"
      */
     scope?: string;
+    /**
+     * ID or name of the organization to use when authenticating a user.
+     * When provided, the user will be authenticated using the organization context.
+     * The organization ID will be present in the access token payload.
+     */
+    organization?: string;
     /**
      * Additional custom parameters for Auth0 Action processing
      *

package/dist/typings/version.d.ts

@@ -1,2 +1,2 @@
-declare const _default: "2.10.0";
+declare const _default: "2.11.0";
 export default _default;

package/package.json

@@ -3,7 +3,7 @@
   "name": "@auth0/auth0-spa-js",
   "description": "Auth0 SDK for Single Page Applications using Authorization Code Grant Flow with PKCE",
   "license": "MIT",
-  "version": "2.10.0",
+  "version": "2.11.0",
   "main": "dist/lib/auth0-spa-js.cjs.js",
   "types": "dist/typings/index.d.ts",
   "module": "dist/auth0-spa-js.production.esm.js",

package/src/Auth0Client.ts

@@ -1422,6 +1422,8 @@ export class Auth0Client {
    * - `scope`: A unique set of scopes, generated by merging the scopes supplied in the options
    *            with the SDK’s default scopes.
    * - `audience`: The target audience from the options, with fallback to the SDK's authorization configuration.
+   * - `organization`: Optional organization ID or name for authenticating the user in an organization context.
+   *                   When provided, the organization ID will be present in the access token payload.
    *
    * **Example Usage:**
    *
@@ -1430,13 +1432,15 @@ export class Auth0Client {
    * const options: CustomTokenExchangeOptions = {
    *   subject_token: 'eyJhbGciOiJIUzI1NiIsInR5cCI6Ikp...',
    *   subject_token_type: 'urn:acme:legacy-system-token',
-   *   scope: "openid profile"
+   *   scope: "openid profile",
+   *   organization: "org_12345"
    * };
    *
    * // Exchange the external token for Auth0 tokens
    * try {
    *   const tokenResponse = await instance.exchangeToken(options);
    *   // Use tokenResponse.access_token, tokenResponse.id_token, etc.
+   *   // The organization ID will be present in the access token payload
    * } catch (error) {
    *   // Handle token exchange error
    * }
@@ -1454,7 +1458,8 @@ export class Auth0Client {
         options.scope,
         options.audience || this.options.authorizationParams.audience
       ),
-      audience: options.audience || this.options.authorizationParams.audience
+      audience: options.audience || this.options.authorizationParams.audience,
+      organization: options.organization || this.options.authorizationParams.organization
     });
   }
 
@@ -1638,6 +1643,7 @@ interface TokenExchangeRequestOptions extends BaseRequestTokenOptions {
   subject_token_type: string;
   actor_token?: string;
   actor_token_type?: string;
+  organization?: string;
 }
 
 interface RequestTokenAdditionalParameters {

package/src/TokenExchange.ts

@@ -57,6 +57,13 @@ export type CustomTokenExchangeOptions = {
    */
   scope?: string;
 
+  /**
+   * ID or name of the organization to use when authenticating a user.
+   * When provided, the user will be authenticated using the organization context.
+   * The organization ID will be present in the access token payload.
+   */
+  organization?: string;
+
   /**
    * Additional custom parameters for Auth0 Action processing
    *

package/src/version.ts

@@ -1 +1 @@
-export default '2.10.0';
+export default '2.11.0';