Skip to content

Deprecate extraQueryParameters #1001

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Nov 6, 2025
+63 −0
Merged

Deprecate extraQueryParameters #1001

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
a7adf8e
Deprecate extraQueryParameters
Avery-Dunn Oct 29, 2025
75bad75
Re-trigger Github checks
Avery-Dunn Nov 4, 2025
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
6 changes: 6 additions & 0 deletions msal4j-sdk/src/main/java/com/microsoft/aad/msal4j/AuthorizationCodeParameters.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -92,6 +92,10 @@ public Map<String, String> extraHttpHeaders() {
return this.extraHttpHeaders;
}

/**
* @deprecated Not recommended for production scenarios. It will be removed in a future release, and the behavior may be replaced by a new API.
*/
@Deprecated
public Map<String, String> extraQueryParameters() {
return this.extraQueryParameters;
}
Expand Down Expand Up @@ -173,7 +177,9 @@ public AuthorizationCodeParametersBuilder extraHttpHeaders(Map<String, String> e

/**
* Adds additional query parameters to the token request
* @deprecated Not recommended for production scenarios. It will be removed in a future release, and the behavior may be replaced by a new API.
*/
@Deprecated
public AuthorizationCodeParametersBuilder extraQueryParameters(Map<String, String> extraQueryParameters) {
this.extraQueryParameters = extraQueryParameters;
return this;
Expand Down
6 changes: 6 additions & 0 deletions msal4j-sdk/src/main/java/com/microsoft/aad/msal4j/AuthorizationRequestUrlParameters.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -234,6 +234,10 @@ public boolean instanceAware() {
return this.instanceAware;
}

/**
* @deprecated Not recommended for production scenarios. It will be removed in a future release, and the behavior may be replaced by a new API.
*/
@Deprecated
Copy link
Contributor

@neha-bhargava neha-bhargava Nov 6, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should this message be accompanied by the new API? I feel the message is a bit confusing if I am already using this API in production.

Copy link
Contributor

@gladjohn gladjohn Nov 6, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

agree, should we mimic MSAL .NET PR here as well?

Copy link
Contributor Author

@Avery-Dunn Avery-Dunn Nov 6, 2025 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

For all the other MSALs we decided to just deprecate the existing API, and not make all the other cache key changes like .NET

Long story short, for .NET we knew there were many customers using a lot of first-party ESTS features for testing (like getting already-expired tokens, simulating an outage, etc.). But for the other languages, the plan is more-or-less to deprecate the existing API and add the new behavior only if a customer specifically asks for it one day.

public Map<String, String> extraQueryParameters() {
return this.extraQueryParameters;
}
Expand Down Expand Up @@ -419,7 +423,9 @@ public Builder instanceAware(boolean val) {
/**
* Query parameters that you can add to the request,
* in addition to the list of parameters already provided.
* @deprecated Not recommended for production scenarios. It will be removed in a future release, and the behavior may be replaced by a new API.
*/
@Deprecated
public Builder extraQueryParameters(Map<String, String> val) {
this.extraQueryParameters = val;
return self();
Expand Down
6 changes: 6 additions & 0 deletions msal4j-sdk/src/main/java/com/microsoft/aad/msal4j/ClientCredentialParameters.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -71,6 +71,10 @@ public Map<String, String> extraHttpHeaders() {
return this.extraHttpHeaders;
}

/**
* @deprecated Not recommended for production scenarios. It will be removed in a future release, and the behavior may be replaced by a new API.
*/
@Deprecated
public Map<String, String> extraQueryParameters() {
return this.extraQueryParameters;
}
Expand Down Expand Up @@ -134,7 +138,9 @@ public ClientCredentialParametersBuilder extraHttpHeaders(Map<String, String> ex

/**
* Adds additional query parameters to the token request
* @deprecated Not recommended for production scenarios. It will be removed in a future release, and the behavior may be replaced by a new API.
*/
@Deprecated
public ClientCredentialParametersBuilder extraQueryParameters(Map<String, String> extraQueryParameters) {
this.extraQueryParameters = extraQueryParameters;
return this;
Expand Down
6 changes: 6 additions & 0 deletions msal4j-sdk/src/main/java/com/microsoft/aad/msal4j/DeviceCodeFlowParameters.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -70,6 +70,10 @@ public Map<String, String> extraHttpHeaders() {
return this.extraHttpHeaders;
}

/**
* @deprecated Not recommended for production scenarios. It will be removed in a future release, and the behavior may be replaced by a new API.
*/
@Deprecated
public Map<String, String> extraQueryParameters() {
return this.extraQueryParameters;
}
Expand Down Expand Up @@ -135,7 +139,9 @@ public DeviceCodeFlowParametersBuilder extraHttpHeaders(Map<String, String> extr

/**
* Adds additional query parameters to the token request
* @deprecated Not recommended for production scenarios. It will be removed in a future release, and the behavior may be replaced by a new API.
*/
@Deprecated
public DeviceCodeFlowParametersBuilder extraQueryParameters(Map<String, String> extraQueryParameters) {
this.extraQueryParameters = extraQueryParameters;
return this;
Expand Down
3 changes: 3 additions & 0 deletions msal4j-sdk/src/main/java/com/microsoft/aad/msal4j/IAcquireTokenParameters.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -62,6 +62,9 @@ interface IAcquireTokenParameters {
* This can be useful for scenarios requiring custom parameters that aren't explicitly supported in the library.
*
* @return A map of additional query parameters to include with the token request, or null if no extra parameters are needed.
*
* @deprecated Not recommended for production scenarios. It will be removed in a future release, and the behavior may be replaced by a new API.
*/
@Deprecated
Map<String, String> extraQueryParameters();
}
6 changes: 6 additions & 0 deletions ...sdk/src/main/java/com/microsoft/aad/msal4j/IntegratedWindowsAuthenticationParameters.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -72,6 +72,10 @@ public Map<String, String> extraHttpHeaders() {
return this.extraHttpHeaders;
}

/**
* @deprecated Not recommended for production scenarios. It will be removed in a future release, and the behavior may be replaced by a new API.
*/
@Deprecated
public Map<String, String> extraQueryParameters() {
return this.extraQueryParameters;
}
Expand Down Expand Up @@ -129,7 +133,9 @@ public IntegratedWindowsAuthenticationParametersBuilder extraHttpHeaders(Map<Str

/**
* Adds additional parameters to the token request
* @deprecated Not recommended for production scenarios. It will be removed in a future release, and the behavior may be replaced by a new API.
*/
@Deprecated
public IntegratedWindowsAuthenticationParametersBuilder extraQueryParameters(Map<String, String> extraQueryParameters) {
this.extraQueryParameters = extraQueryParameters;
return this;
Expand Down
6 changes: 6 additions & 0 deletions msal4j-sdk/src/main/java/com/microsoft/aad/msal4j/InteractiveRequestParameters.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -113,6 +113,10 @@ public Map<String, String> extraHttpHeaders() {
return this.extraHttpHeaders;
}

/**
* @deprecated Not recommended for production scenarios. It will be removed in a future release, and the behavior may be replaced by a new API.
*/
@Deprecated
public Map<String, String> extraQueryParameters() {
return this.extraQueryParameters;
}
Expand Down Expand Up @@ -262,7 +266,9 @@ public InteractiveRequestParametersBuilder extraHttpHeaders(Map<String, String>

/**
* Adds additional query parameters to the token request
* @deprecated Not recommended for production scenarios. It will be removed in a future release, and the behavior may be replaced by a new API.
*/
@Deprecated
public InteractiveRequestParametersBuilder extraQueryParameters(Map<String, String> extraQueryParameters) {
this.extraQueryParameters = extraQueryParameters;
return this;
Expand Down
6 changes: 6 additions & 0 deletions msal4j-sdk/src/main/java/com/microsoft/aad/msal4j/OnBehalfOfParameters.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -76,6 +76,10 @@ public Map<String, String> extraHttpHeaders() {
return this.extraHttpHeaders;
}

/**
* @deprecated Not recommended for production scenarios. It will be removed in a future release, and the behavior may be replaced by a new API.
*/
@Deprecated
public Map<String, String> extraQueryParameters() {
return this.extraQueryParameters;
}
Expand Down Expand Up @@ -136,7 +140,9 @@ public OnBehalfOfParametersBuilder extraHttpHeaders(Map<String, String> extraHtt

/**
* Adds additional parameters to the token request
* @deprecated Not recommended for production scenarios. It will be removed in a future release, and the behavior may be replaced by a new API.
*/
@Deprecated
public OnBehalfOfParametersBuilder extraQueryParameters(Map<String, String> extraQueryParameters) {
this.extraQueryParameters = extraQueryParameters;
return this;
Expand Down
6 changes: 6 additions & 0 deletions msal4j-sdk/src/main/java/com/microsoft/aad/msal4j/RefreshTokenParameters.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -72,6 +72,10 @@ public Map<String, String> extraHttpHeaders() {
return this.extraHttpHeaders;
}

/**
* @deprecated Not recommended for production scenarios. It will be removed in a future release, and the behavior may be replaced by a new API.
*/
@Deprecated
public Map<String, String> extraQueryParameters() {
return this.extraQueryParameters;
}
Expand Down Expand Up @@ -133,7 +137,9 @@ public RefreshTokenParametersBuilder extraHttpHeaders(Map<String, String> extraH

/**
* Adds additional parameters to the token request
* @deprecated Not recommended for production scenarios. It will be removed in a future release, and the behavior may be replaced by a new API.
*/
@Deprecated
public RefreshTokenParametersBuilder extraQueryParameters(Map<String, String> extraQueryParameters) {
this.extraQueryParameters = extraQueryParameters;
return this;
Expand Down
6 changes: 6 additions & 0 deletions msal4j-sdk/src/main/java/com/microsoft/aad/msal4j/SilentParameters.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -119,6 +119,10 @@ public Map<String, String> extraHttpHeaders() {
return this.extraHttpHeaders;
}

/**
* @deprecated Not recommended for production scenarios. It will be removed in a future release, and the behavior may be replaced by a new API.
*/
@Deprecated
public Map<String, String> extraQueryParameters() {
return this.extraQueryParameters;
}
Expand Down Expand Up @@ -215,7 +219,9 @@ public SilentParametersBuilder extraHttpHeaders(Map<String, String> extraHttpHea

/**
* Adds additional query parameters to the token request
* @deprecated Not recommended for production scenarios. It will be removed in a future release, and the behavior may be replaced by a new API.
*/
@Deprecated
public SilentParametersBuilder extraQueryParameters(Map<String, String> extraQueryParameters) {
this.extraQueryParameters = extraQueryParameters;
return this;
Expand Down
6 changes: 6 additions & 0 deletions msal4j-sdk/src/main/java/com/microsoft/aad/msal4j/UserNamePasswordParameters.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -88,6 +88,10 @@ public Map<String, String> extraHttpHeaders() {
return this.extraHttpHeaders;
}

/**
* @deprecated Not recommended for production scenarios. It will be removed in a future release, and the behavior may be replaced by a new API.
*/
@Deprecated
public Map<String, String> extraQueryParameters() {
return this.extraQueryParameters;
}
Expand Down Expand Up @@ -180,7 +184,9 @@ public UserNamePasswordParametersBuilder extraHttpHeaders(Map<String, String> ex

/**
* Adds additional query parameters to the token request
* @deprecated Not recommended for production scenarios. It will be removed in a future release, and the behavior may be replaced by a new API.
*/
@Deprecated
public UserNamePasswordParametersBuilder extraQueryParameters(Map<String, String> extraQueryParameters) {
this.extraQueryParameters = extraQueryParameters;
return this;
Expand Down
Loading