[v5] Add support for authorize call using method POST

change/@azure-msal-browser-4609ddb5-5e7c-4f8d-ac16-4ae33329fcaf.json

@@ -0,0 +1,7 @@
+{
+  "type": "minor",
+  "comment": "Add support for authorize call using method POST #7997",
+  "packageName": "@azure/msal-browser",
+  "email": "[email protected]",
+  "dependentChangeType": "patch"
+}

change/@azure-msal-common-fceb1ded-fc1f-498a-ba0a-c2b18d4b3e12.json

@@ -0,0 +1,7 @@
+{
+  "type": "minor",
+  "comment": "Add support for authorize call using method POST#7997",
+  "packageName": "@azure/msal-common",
+  "email": "[email protected]",
+  "dependentChangeType": "patch"
+}

change/@azure-msal-node-af4e8122-18b1-4997-9d45-4c2aba0eb9f5.json

@@ -0,0 +1,7 @@
+{
+  "type": "major",
+  "comment": "Update tests to account for changes in extra param configuration",
+  "packageName": "@azure/msal-node",
+  "email": "[email protected]",
+  "dependentChangeType": "patch"
+}

docs/errors.md

@@ -262,6 +262,9 @@ This error occurs when MSAL.js surpasses the allotted storage limit when attempt
 
 -   Authority mismatch error. Authority provided in login request or PublicClientApplication config does not match the environment of the provided account. Please use a matching account or make an interactive request to login to this authority.
 
+### `invalid_request_method_for_EAR`
+- The `httpMethod` parameter in all requests using `protocolMode: ProtocolMode.EAR` must be either unset or `"POST"`/`HttpMethod.POST`. The EAR protocol cannot be used with HTTP method `GET`.
+
 ## Interaction required errors
 
 ### `no_tokens_found`

lib/msal-browser/apiReview/msal-browser.api.md

@@ -549,7 +549,7 @@ const emptyWindowError = "empty_window_error";
 // Warning: (ae-missing-release-tag) "EndSessionPopupRequest" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal)
 //
 // @public
-export type EndSessionPopupRequest = Partial<Omit<CommonEndSessionRequest, "tokenQueryParameters">> & {
+export type EndSessionPopupRequest = Partial<CommonEndSessionRequest> & {
     authority?: string;
     mainWindowRedirectUri?: string;
     popupWindowAttributes?: PopupWindowAttributes;
@@ -559,7 +559,7 @@ export type EndSessionPopupRequest = Partial<Omit<CommonEndSessionRequest, "toke
 // Warning: (ae-missing-release-tag) "EndSessionRequest" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal)
 //
 // @public
-export type EndSessionRequest = Partial<Omit<CommonEndSessionRequest, "tokenQueryParameters">> & {
+export type EndSessionRequest = Partial<CommonEndSessionRequest> & {
     authority?: string;
 };
 

lib/msal-browser/docs/v4-migration.md

@@ -24,29 +24,31 @@ if (result) {
 
 // AFTER
 const shr = new SignedHttpRequest(shrParameters, shrOptions);
-await shr.removeKeys(thumbprint).then(() => {
-    // do something on success
-}).catch(e => {
-    // do something on failure
-    console.log(e);
-});
+await shr
+    .removeKeys(thumbprint)
+    .then(() => {
+        // do something on success
+    })
+    .catch((e) => {
+        // do something on failure
+        console.log(e);
+    });
 ```
 
 ### TokenCache and loadExternalTokens
 
 MSAL JS API for [loadExternalTokens](../testing.md#the-loadexternaltokens-api) is modified. The changes include:
-* `TokenCache` object and `getTokenCache()` have been removed
-* The `loadExternalTokens()` API is now a separate export and requires `Configuration` as a parameter
+
+-   `TokenCache` object and `getTokenCache()` have been removed
+-   The `loadExternalTokens()` API is now a separate export and requires `Configuration` as a parameter
 
 ```js
 // BEFORE
 
 const pca = new PublicClientApplication(config);
-await pca.getTokenCache().loadExternalTokens(
-    silentRequest,
-    serverResponse,
-    loadTokenOptions
-);
+await pca
+    .getTokenCache()
+    .loadExternalTokens(silentRequest, serverResponse, loadTokenOptions);
 
 //AFTER
 
@@ -65,19 +67,19 @@ Previously, `PublicClientApplication.handleRedirectPromise` took in an optional
 ```javascript
 // BEFORE
 const hash = window.location.hash; // Arbitrary example value
-pca.handleRedirectPromise(hash)
-
+pca.handleRedirectPromise(hash);
 
 // AFTER
 pca.handleRedirectPromise({
     hash: window.location.hash, // Option nested inside a `HandleRedirectPromiseOptions` object
-    navigateToLoginRequestUrl: true // Additional option
-})
+    navigateToLoginRequestUrl: true, // Additional option
+});
 ```
 
-### Removal of some functions in `PublicClientApplication` 
+### Removal of some functions in `PublicClientApplication`
 
 The following functions in `PublicClientApplication` have been removed:
+
 1. `enableAccountStorageEvents()` and `disableAccountStorageEvents()`: account storage events are now always enabled. These function calls are no longer necessary.
 1. `getAccountByHomeId()`, `getAccountByLocalId()`, and `getAccountByUsername()`: use `getAccount()` instead.
 
@@ -88,10 +90,15 @@ The following functions in `PublicClientApplication` have been removed:
     const account3 = accountManager.getAccountByUsername(yourUsername);
 
     // AFTER
-    const account1 = accountManager.getAccount({ homeAccountId: yourHomeAccountId });
-    const account2 = accountManager.getAccount({ localAccountId: yourLocalAccountId });
+    const account1 = accountManager.getAccount({
+        homeAccountId: yourHomeAccountId,
+    });
+    const account2 = accountManager.getAccount({
+        localAccountId: yourLocalAccountId,
+    });
     const account3 = accountManager.getAccount({ username: yourUsername });
     ```
+
 1. `logout()`: use `logoutRedirect()` or `logoutPopup()` instead.
 
 ### Removal of `startPerformanceMeasurement()`
@@ -108,10 +115,12 @@ The following functions in `PublicClientApplication` have been removed:
 1. The `navigateTologinRequestUrl` parameter has been removed from BrowserAuthOptions in Configuration and can instead now be provided inside an options object as a parameter on the call to `handleRedirectPromise`:
 
     ```typescript
-      pca.handleRedirectPromise({ navigateToLoginRequestUrl: false })
+    pca.handleRedirectPromise({ navigateToLoginRequestUrl: false });
     ```
+
 1. The `encodeExtraQueryParams` parameter has been removed. All extra query params will be encoded.
 1. The `supportsNestedAppAuth` parameter has been removed. Use `createNestablePublicClientApplication()` instead.
+
     ```typescript
         // BEFORE
         const pca = new PublicClientApplication({
@@ -130,6 +139,7 @@ The following functions in `PublicClientApplication` have been removed:
             }
         });
     ```
+
 1. The `OIDCOptions` parameter now takes in a `ResponseMode` instead of a `ServerResponseType`. Please use `ResponseMode.QUERY` in place of `ServerResponseType.QUERY` and `ResponseMode.FRAGMENT` instead of `ServerResponseType.FRAGMENT`.
 
 ### CacheOptions changes
@@ -161,6 +171,81 @@ See the [Configuration doc](./configuration.md#system-config-options) for more d
 
 The `onRedirectNavigate` parameter will *only be supported* from `Configuration` object going forward and is removed from `RedirectRequest` and `EndSessionRequest` objects. Please ensure to set it in msal config if you need to use it.
 
+### Consolidation of extra request parameters
+
+The following request parameters have been removed:
+
+-   `authorizePostBodyParams`
+-   `tokenBodyParameters`
+-   `tokenQueryParameters`
+
+In order to simplify extra request parameters, generic extra parameters should go in the new `extraParams` request option. When `extraParams` are set in a request, they will be sent on all token service calls in either the URL query string or the request body, depending on the `httpMethod` configured (default is `GET`) in the request. **To submit extra parameters that MUST go in the URL query string, `extraQueryParameters` is still available.**
+
+> Note: In cases where MSAL determines `extraParams` must be encoded into the URL string, `extraParams` will be merged with `extraQueryParams` in a way that will cause same-named parameters to be overwritten. In these cases, the value for the parameter in `extraParams` will take precedence over the value in the `extraQueryParams`.
+
+#### v4 (previous) request example:
+
+```javascript
+// Example of a GET request with extra parameters
+const authRequest = {
+    scopes: ["SAMPLE_SCOPE"],
+    extraQueryParamters: {
+        "extra_parameter_one": "sample_value" // This was sent on the query string on GET /authorize
+    },
+    tokenBodyParameters: {
+        "extra_parameter_assertion": "assertion_value" // This was sent on the POST body to /token
+    },
+    tokenQueryParamters: {
+        "extra_parameter_one": "sample_value" // This was sent on the query string on POST /token
+    }
+}
+
+// Example of a POST request with extra parameters
+const authRequest = {
+    scopes: ["SAMPLE_SCOPE"],
+    httpMethod: "POST", // default is "GET" -> Determines method for "/authorize" call. Calls to "/token" are always POST
+    extraQueryParamters: {
+        "extra_parameter_one": "sample_value" // This was sent on the query string on POST /authorize
+    },
+    authorizePostBodyParameters: {
+        "extra_parameters_assertion": "assertion_value", // This was sent on the body on POST /authorize
+    }
+    tokenBodyParameters: {
+        "extra_parameter_assertion": "assertion_value" // This was sent on the POST body to /token
+    },
+    tokenQueryParamters: {
+        "extra_parameter_one": "sample_value" // This was sent on the query string on POST /token
+    }
+}
+```
+
+#### v5 Request Example
+
+```javascript
+// Example of a GET request with extra parameters
+const authRequest = {
+    scopes: ["SAMPLE_SCOPE"],
+    extraQueryParamters: {
+        extra_parameter_one: "sample_value", // Will be sent in query string to /authorize and /token
+    },
+    extraParams: {
+        extra_parameter_assertion: "assertion_value", // Will be sent in query stirng to /authorize and in body to /token
+    },
+};
+
+// Example of a POST request with extra parameters
+const authRequest = {
+    scopes: ["SAMPLE_SCOPE"],
+    httpMethod: "POST", // default is "GET" -> Determines method for "/authorize" call. Calls to "/token" are always POST
+    extraQueryParamters: {
+        extra_parameter_one: "sample_value", // Will be sent in query string to /authorize and /token
+    },
+    extraParams: {
+        extra_parameter_assertion: "assertion_value", // Will be sent in post body to /authorize and /token
+    },
+};
+```
+
 ## Behavioral Breaking Changes
 
 ### Event types and InteractionStatus changes

lib/msal-browser/src/interaction_client/PlatformAuthInteractionClient.ts

@@ -956,7 +956,7 @@ export class PlatformAuthInteractionClient extends BaseInteractionClient {
             windowTitleSubstring: document.title,
             extraParameters: {
                 ...request.extraQueryParameters,
-                ...request.tokenQueryParameters,
+                ...request.extraParams,
             },
             extendedExpiryToken: false, // Make this configurable?
             keyId: request.popKid,