Add ExtraHeaderParameters and ExtraQueryParameters support to DownstreamApi by Copilot · Pull Request #3413 · AzureAD/microsoft-identity-web

Copilot · 2025-07-14T20:46:20Z

This PR implements support for ExtraHeaderParameters and ExtraQueryParameters properties on DownstreamApiOptions to simplify adding custom headers and query parameters to downstream API requests.

Problem

Previously, developers had to use the complex CustomizeHttpRequestMessage delegate to add custom headers and query parameters to downstream API calls:

varresult=awaitdownstreamApi.GetForAppAsync<string>("Api",
options =>{options.CustomizeHttpRequestMessage= requestMessage =>{requestMessage.Headers.Add("OData-Version","4.0");// Query parameters would need manual URL manipulation};});

Solution

This PR adds support for the more convenient ExtraHeaderParameters and ExtraQueryParameters properties:

varresult=awaitdownstreamApi.GetForAppAsync<string>("Api",
options =>{options.ExtraHeaderParameters=newDictionary<string,string>{{"OData-Version","4.0"},{"X-Custom-Header","value"}};options.ExtraQueryParameters=newDictionary<string,string>{{"version","v2"},{"format","json"}};});

Implementation Details

Key Features

Reflection-based detection - Uses reflection to check if properties exist on DownstreamApiOptions for backward compatibility
Dual naming support - Supports both "ExtraHeaderParameters" and "ExtraHeadersParameters" naming conventions
Proper URL encoding - Query parameters are automatically URL-encoded using Uri.EscapeDataString
Maintains existing behavior - Works alongside existing CustomizeHttpRequestMessage delegate
Comprehensive test coverage - Tests for headers, query parameters, edge cases, and special characters

Technical Changes

Added GetExtraHeaderParameters() and GetExtraQueryParameters() helper methods in DownstreamApi class
Enhanced UpdateRequestAsync() method to apply extra parameters before CustomizeHttpRequestMessage is called
Updated all target framework InternalAPI files with new method signatures
Created comprehensive test suite in ExtraParametersTests.cs

Header Processing

Headers are added using TryAddWithoutValidation to support custom header schemes
Applied before CustomizeHttpRequestMessage delegate, allowing for override
Empty or null dictionaries are safely ignored

Query Parameter Processing

Parameters are properly URL-encoded for safety
Correctly appends to existing query parameters in the URL
Handles special characters and spaces correctly

Testing

The implementation includes comprehensive tests covering:

Adding extra headers to requests
Adding extra query parameters with proper URL encoding
Appending to existing query parameters
Handling special characters and spaces
Edge cases with null/empty dictionaries
Alternate naming conventions (ExtraHeadersParameters vs ExtraHeaderParameters)

Backward Compatibility

The implementation uses reflection to detect if these properties exist on DownstreamApiOptions, ensuring full backward compatibility with different versions of the Microsoft.Identity.Abstractions package.

Dependencies

This feature assumes that the ExtraHeaderParameters and ExtraQueryParameters properties will be added to DownstreamApiOptions in the Microsoft.Identity.Abstractions package as mentioned in the related issue.

Fixes#3387.

💡 You can make Copilot smarter by setting up custom instructions, customizing its development environment and configuring Model Context Protocol (MCP) servers. Learn more Copilot coding agent tips in the docs.

…ueryParameters to DownstreamApiOptions Co-authored-by: jmprieur <13203188+jmprieur@users.noreply.github.com>

…ownstreamApi Co-authored-by: jmprieur <13203188+jmprieur@users.noreply.github.com>

…tion Co-authored-by: jmprieur <13203188+jmprieur@users.noreply.github.com>

Jean-Marc Prieur (jmprieur)

A few suggestions for improvements

Jean-Marc Prieur (jmprieur) · 2025-07-14T21:37:24Z

Copilot I've reviewed the PR and have suggestions for improvements

…rParameters and ExtraQueryParameters Co-authored-by: jmprieur <13203188+jmprieur@users.noreply.github.com>

Copilot · 2025-07-14T21:53:59Z

Copilot I've reviewed the PR and have suggestions for improvements

I've implemented the improvements by removing the unnecessary helper methods GetExtraHeaderParameters() and GetExtraQueryParameters() that were just pass-through methods. The code now directly accesses effectiveOptions.ExtraHeaderParameters and effectiveOptions.ExtraQueryParameters properties, making it cleaner and more straightforward.

…ExtraQueryParameters access Co-authored-by: jmprieur <13203188+jmprieur@users.noreply.github.com>

Co-authored-by: jmprieur <13203188+jmprieur@users.noreply.github.com>

Jean-Marc Prieur (jmprieur)

Copilot I left a few comments

…Options directly Co-authored-by: jmprieur <13203188+jmprieur@users.noreply.github.com>

Copilot · 2025-07-14T20:46:20Z

This PR implements support for ExtraHeaderParameters and ExtraQueryParameters properties on DownstreamApiOptions to simplify adding custom headers and query parameters to downstream API requests.

Problem

Previously, developers had to use the complex CustomizeHttpRequestMessage delegate to add custom headers and query parameters to downstream API calls:

varresult=awaitdownstreamApi.GetForAppAsync<string>("Api",
options =>{options.CustomizeHttpRequestMessage= requestMessage =>{requestMessage.Headers.Add("OData-Version","4.0");// Query parameters would need manual URL manipulation};});

Solution

This PR adds support for the more convenient ExtraHeaderParameters and ExtraQueryParameters properties:

varresult=awaitdownstreamApi.GetForAppAsync<string>("Api",
options =>{options.ExtraHeaderParameters=newDictionary<string,string>{{"OData-Version","4.0"},{"X-Custom-Header","value"}};options.ExtraQueryParameters=newDictionary<string,string>{{"version","v2"},{"format","json"}};});

Implementation Details

Key Features

Reflection-based detection - Uses reflection to check if properties exist on DownstreamApiOptions for backward compatibility
Dual naming support - Supports both "ExtraHeaderParameters" and "ExtraHeadersParameters" naming conventions
Proper URL encoding - Query parameters are automatically URL-encoded using Uri.EscapeDataString
Maintains existing behavior - Works alongside existing CustomizeHttpRequestMessage delegate
Comprehensive test coverage - Tests for headers, query parameters, edge cases, and special characters

Technical Changes

Added GetExtraHeaderParameters() and GetExtraQueryParameters() helper methods in DownstreamApi class
Enhanced UpdateRequestAsync() method to apply extra parameters before CustomizeHttpRequestMessage is called
Updated all target framework InternalAPI files with new method signatures
Created comprehensive test suite in ExtraParametersTests.cs

Header Processing

Headers are added using TryAddWithoutValidation to support custom header schemes
Applied before CustomizeHttpRequestMessage delegate, allowing for override
Empty or null dictionaries are safely ignored

Query Parameter Processing

Parameters are properly URL-encoded for safety
Correctly appends to existing query parameters in the URL
Handles special characters and spaces correctly

Testing

The implementation includes comprehensive tests covering:

Adding extra headers to requests
Adding extra query parameters with proper URL encoding
Appending to existing query parameters
Handling special characters and spaces
Edge cases with null/empty dictionaries
Alternate naming conventions (ExtraHeadersParameters vs ExtraHeaderParameters)

Backward Compatibility

The implementation uses reflection to detect if these properties exist on DownstreamApiOptions, ensuring full backward compatibility with different versions of the Microsoft.Identity.Abstractions package.

Dependencies

This feature assumes that the ExtraHeaderParameters and ExtraQueryParameters properties will be added to DownstreamApiOptions in the Microsoft.Identity.Abstractions package as mentioned in the related issue.

Fixes#3387.

💡 You can make Copilot smarter by setting up custom instructions, customizing its development environment and configuring Model Context Protocol (MCP) servers. Learn more Copilot coding agent tips in the docs.

…ueryParameters to DownstreamApiOptions Co-authored-by: jmprieur <13203188+jmprieur@users.noreply.github.com>

…ownstreamApi Co-authored-by: jmprieur <13203188+jmprieur@users.noreply.github.com>

…tion Co-authored-by: jmprieur <13203188+jmprieur@users.noreply.github.com>

Jean-Marc Prieur (jmprieur)

A few suggestions for improvements

Jean-Marc Prieur (jmprieur) · 2025-07-14T21:37:24Z

Copilot I've reviewed the PR and have suggestions for improvements

…rParameters and ExtraQueryParameters Co-authored-by: jmprieur <13203188+jmprieur@users.noreply.github.com>

Copilot · 2025-07-14T21:53:59Z

Copilot I've reviewed the PR and have suggestions for improvements

I've implemented the improvements by removing the unnecessary helper methods GetExtraHeaderParameters() and GetExtraQueryParameters() that were just pass-through methods. The code now directly accesses effectiveOptions.ExtraHeaderParameters and effectiveOptions.ExtraQueryParameters properties, making it cleaner and more straightforward.

…ExtraQueryParameters access Co-authored-by: jmprieur <13203188+jmprieur@users.noreply.github.com>

Co-authored-by: jmprieur <13203188+jmprieur@users.noreply.github.com>

Jean-Marc Prieur (jmprieur)

Copilot I left a few comments

…Options directly Co-authored-by: jmprieur <13203188+jmprieur@users.noreply.github.com>

Copilot · 2025-07-14T20:46:20Z

This PR implements support for ExtraHeaderParameters and ExtraQueryParameters properties on DownstreamApiOptions to simplify adding custom headers and query parameters to downstream API requests.

Problem

Previously, developers had to use the complex CustomizeHttpRequestMessage delegate to add custom headers and query parameters to downstream API calls:

varresult=awaitdownstreamApi.GetForAppAsync<string>("Api",
options =>{options.CustomizeHttpRequestMessage= requestMessage =>{requestMessage.Headers.Add("OData-Version","4.0");// Query parameters would need manual URL manipulation};});

Solution

This PR adds support for the more convenient ExtraHeaderParameters and ExtraQueryParameters properties:

varresult=awaitdownstreamApi.GetForAppAsync<string>("Api",
options =>{options.ExtraHeaderParameters=newDictionary<string,string>{{"OData-Version","4.0"},{"X-Custom-Header","value"}};options.ExtraQueryParameters=newDictionary<string,string>{{"version","v2"},{"format","json"}};});

Implementation Details

Key Features

Reflection-based detection - Uses reflection to check if properties exist on DownstreamApiOptions for backward compatibility
Dual naming support - Supports both "ExtraHeaderParameters" and "ExtraHeadersParameters" naming conventions
Proper URL encoding - Query parameters are automatically URL-encoded using Uri.EscapeDataString
Maintains existing behavior - Works alongside existing CustomizeHttpRequestMessage delegate
Comprehensive test coverage - Tests for headers, query parameters, edge cases, and special characters

Technical Changes

Added GetExtraHeaderParameters() and GetExtraQueryParameters() helper methods in DownstreamApi class
Enhanced UpdateRequestAsync() method to apply extra parameters before CustomizeHttpRequestMessage is called
Updated all target framework InternalAPI files with new method signatures
Created comprehensive test suite in ExtraParametersTests.cs

Header Processing

Headers are added using TryAddWithoutValidation to support custom header schemes
Applied before CustomizeHttpRequestMessage delegate, allowing for override
Empty or null dictionaries are safely ignored

Query Parameter Processing

Parameters are properly URL-encoded for safety
Correctly appends to existing query parameters in the URL
Handles special characters and spaces correctly

Testing

The implementation includes comprehensive tests covering:

Adding extra headers to requests
Adding extra query parameters with proper URL encoding
Appending to existing query parameters
Handling special characters and spaces
Edge cases with null/empty dictionaries
Alternate naming conventions (ExtraHeadersParameters vs ExtraHeaderParameters)

Backward Compatibility

The implementation uses reflection to detect if these properties exist on DownstreamApiOptions, ensuring full backward compatibility with different versions of the Microsoft.Identity.Abstractions package.

Dependencies

This feature assumes that the ExtraHeaderParameters and ExtraQueryParameters properties will be added to DownstreamApiOptions in the Microsoft.Identity.Abstractions package as mentioned in the related issue.

Fixes#3387.

💡 You can make Copilot smarter by setting up custom instructions, customizing its development environment and configuring Model Context Protocol (MCP) servers. Learn more Copilot coding agent tips in the docs.

…ueryParameters to DownstreamApiOptions Co-authored-by: jmprieur <13203188+jmprieur@users.noreply.github.com>

…ownstreamApi Co-authored-by: jmprieur <13203188+jmprieur@users.noreply.github.com>

…tion Co-authored-by: jmprieur <13203188+jmprieur@users.noreply.github.com>

Jean-Marc Prieur (jmprieur)

A few suggestions for improvements

Jean-Marc Prieur (jmprieur) · 2025-07-14T21:37:24Z

Copilot I've reviewed the PR and have suggestions for improvements

…rParameters and ExtraQueryParameters Co-authored-by: jmprieur <13203188+jmprieur@users.noreply.github.com>

Copilot · 2025-07-14T21:53:59Z

Copilot I've reviewed the PR and have suggestions for improvements

I've implemented the improvements by removing the unnecessary helper methods GetExtraHeaderParameters() and GetExtraQueryParameters() that were just pass-through methods. The code now directly accesses effectiveOptions.ExtraHeaderParameters and effectiveOptions.ExtraQueryParameters properties, making it cleaner and more straightforward.

…ExtraQueryParameters access Co-authored-by: jmprieur <13203188+jmprieur@users.noreply.github.com>

Co-authored-by: jmprieur <13203188+jmprieur@users.noreply.github.com>

Jean-Marc Prieur (jmprieur)

Copilot I left a few comments

…Options directly Co-authored-by: jmprieur <13203188+jmprieur@users.noreply.github.com>

Copilot · 2025-07-14T20:46:20Z

This PR implements support for ExtraHeaderParameters and ExtraQueryParameters properties on DownstreamApiOptions to simplify adding custom headers and query parameters to downstream API requests.

Problem

Previously, developers had to use the complex CustomizeHttpRequestMessage delegate to add custom headers and query parameters to downstream API calls:

varresult=awaitdownstreamApi.GetForAppAsync<string>("Api",
options =>{options.CustomizeHttpRequestMessage= requestMessage =>{requestMessage.Headers.Add("OData-Version","4.0");// Query parameters would need manual URL manipulation};});

Solution

This PR adds support for the more convenient ExtraHeaderParameters and ExtraQueryParameters properties:

varresult=awaitdownstreamApi.GetForAppAsync<string>("Api",
options =>{options.ExtraHeaderParameters=newDictionary<string,string>{{"OData-Version","4.0"},{"X-Custom-Header","value"}};options.ExtraQueryParameters=newDictionary<string,string>{{"version","v2"},{"format","json"}};});

Implementation Details

Key Features

Reflection-based detection - Uses reflection to check if properties exist on DownstreamApiOptions for backward compatibility
Dual naming support - Supports both "ExtraHeaderParameters" and "ExtraHeadersParameters" naming conventions
Proper URL encoding - Query parameters are automatically URL-encoded using Uri.EscapeDataString
Maintains existing behavior - Works alongside existing CustomizeHttpRequestMessage delegate
Comprehensive test coverage - Tests for headers, query parameters, edge cases, and special characters

Technical Changes

Added GetExtraHeaderParameters() and GetExtraQueryParameters() helper methods in DownstreamApi class
Enhanced UpdateRequestAsync() method to apply extra parameters before CustomizeHttpRequestMessage is called
Updated all target framework InternalAPI files with new method signatures
Created comprehensive test suite in ExtraParametersTests.cs

Header Processing

Headers are added using TryAddWithoutValidation to support custom header schemes
Applied before CustomizeHttpRequestMessage delegate, allowing for override
Empty or null dictionaries are safely ignored

Query Parameter Processing

Parameters are properly URL-encoded for safety
Correctly appends to existing query parameters in the URL
Handles special characters and spaces correctly

Testing

The implementation includes comprehensive tests covering:

Adding extra headers to requests
Adding extra query parameters with proper URL encoding
Appending to existing query parameters
Handling special characters and spaces
Edge cases with null/empty dictionaries
Alternate naming conventions (ExtraHeadersParameters vs ExtraHeaderParameters)

Backward Compatibility

The implementation uses reflection to detect if these properties exist on DownstreamApiOptions, ensuring full backward compatibility with different versions of the Microsoft.Identity.Abstractions package.

Dependencies

This feature assumes that the ExtraHeaderParameters and ExtraQueryParameters properties will be added to DownstreamApiOptions in the Microsoft.Identity.Abstractions package as mentioned in the related issue.

Fixes#3387.

💡 You can make Copilot smarter by setting up custom instructions, customizing its development environment and configuring Model Context Protocol (MCP) servers. Learn more Copilot coding agent tips in the docs.

…ueryParameters to DownstreamApiOptions Co-authored-by: jmprieur <13203188+jmprieur@users.noreply.github.com>

…ownstreamApi Co-authored-by: jmprieur <13203188+jmprieur@users.noreply.github.com>

…tion Co-authored-by: jmprieur <13203188+jmprieur@users.noreply.github.com>

Jean-Marc Prieur (jmprieur)

A few suggestions for improvements

Jean-Marc Prieur (jmprieur) · 2025-07-14T21:37:24Z

Copilot I've reviewed the PR and have suggestions for improvements

…rParameters and ExtraQueryParameters Co-authored-by: jmprieur <13203188+jmprieur@users.noreply.github.com>

Copilot · 2025-07-14T21:53:59Z

Copilot I've reviewed the PR and have suggestions for improvements

I've implemented the improvements by removing the unnecessary helper methods GetExtraHeaderParameters() and GetExtraQueryParameters() that were just pass-through methods. The code now directly accesses effectiveOptions.ExtraHeaderParameters and effectiveOptions.ExtraQueryParameters properties, making it cleaner and more straightforward.

…ExtraQueryParameters access Co-authored-by: jmprieur <13203188+jmprieur@users.noreply.github.com>

Co-authored-by: jmprieur <13203188+jmprieur@users.noreply.github.com>

Jean-Marc Prieur (jmprieur)

Copilot I left a few comments

…Options directly Co-authored-by: jmprieur <13203188+jmprieur@users.noreply.github.com>

Copilot · 2025-07-14T20:46:20Z

This PR implements support for ExtraHeaderParameters and ExtraQueryParameters properties on DownstreamApiOptions to simplify adding custom headers and query parameters to downstream API requests.

Problem

Previously, developers had to use the complex CustomizeHttpRequestMessage delegate to add custom headers and query parameters to downstream API calls:

varresult=awaitdownstreamApi.GetForAppAsync<string>("Api",
options =>{options.CustomizeHttpRequestMessage= requestMessage =>{requestMessage.Headers.Add("OData-Version","4.0");// Query parameters would need manual URL manipulation};});

Solution

This PR adds support for the more convenient ExtraHeaderParameters and ExtraQueryParameters properties:

varresult=awaitdownstreamApi.GetForAppAsync<string>("Api",
options =>{options.ExtraHeaderParameters=newDictionary<string,string>{{"OData-Version","4.0"},{"X-Custom-Header","value"}};options.ExtraQueryParameters=newDictionary<string,string>{{"version","v2"},{"format","json"}};});

Implementation Details

Key Features

Reflection-based detection - Uses reflection to check if properties exist on DownstreamApiOptions for backward compatibility
Dual naming support - Supports both "ExtraHeaderParameters" and "ExtraHeadersParameters" naming conventions
Proper URL encoding - Query parameters are automatically URL-encoded using Uri.EscapeDataString
Maintains existing behavior - Works alongside existing CustomizeHttpRequestMessage delegate
Comprehensive test coverage - Tests for headers, query parameters, edge cases, and special characters

Technical Changes

Added GetExtraHeaderParameters() and GetExtraQueryParameters() helper methods in DownstreamApi class
Enhanced UpdateRequestAsync() method to apply extra parameters before CustomizeHttpRequestMessage is called
Updated all target framework InternalAPI files with new method signatures
Created comprehensive test suite in ExtraParametersTests.cs

Header Processing

Headers are added using TryAddWithoutValidation to support custom header schemes
Applied before CustomizeHttpRequestMessage delegate, allowing for override
Empty or null dictionaries are safely ignored

Query Parameter Processing

Parameters are properly URL-encoded for safety
Correctly appends to existing query parameters in the URL
Handles special characters and spaces correctly

Testing

The implementation includes comprehensive tests covering:

Adding extra headers to requests
Adding extra query parameters with proper URL encoding
Appending to existing query parameters
Handling special characters and spaces
Edge cases with null/empty dictionaries
Alternate naming conventions (ExtraHeadersParameters vs ExtraHeaderParameters)

Backward Compatibility

The implementation uses reflection to detect if these properties exist on DownstreamApiOptions, ensuring full backward compatibility with different versions of the Microsoft.Identity.Abstractions package.

Dependencies

This feature assumes that the ExtraHeaderParameters and ExtraQueryParameters properties will be added to DownstreamApiOptions in the Microsoft.Identity.Abstractions package as mentioned in the related issue.

Fixes#3387.

💡 You can make Copilot smarter by setting up custom instructions, customizing its development environment and configuring Model Context Protocol (MCP) servers. Learn more Copilot coding agent tips in the docs.

…ueryParameters to DownstreamApiOptions Co-authored-by: jmprieur <13203188+jmprieur@users.noreply.github.com>

…ownstreamApi Co-authored-by: jmprieur <13203188+jmprieur@users.noreply.github.com>

…tion Co-authored-by: jmprieur <13203188+jmprieur@users.noreply.github.com>

Jean-Marc Prieur (jmprieur)

A few suggestions for improvements

Jean-Marc Prieur (jmprieur) · 2025-07-14T21:37:24Z

Copilot I've reviewed the PR and have suggestions for improvements

…rParameters and ExtraQueryParameters Co-authored-by: jmprieur <13203188+jmprieur@users.noreply.github.com>

Copilot · 2025-07-14T21:53:59Z

Copilot I've reviewed the PR and have suggestions for improvements

I've implemented the improvements by removing the unnecessary helper methods GetExtraHeaderParameters() and GetExtraQueryParameters() that were just pass-through methods. The code now directly accesses effectiveOptions.ExtraHeaderParameters and effectiveOptions.ExtraQueryParameters properties, making it cleaner and more straightforward.

…ExtraQueryParameters access Co-authored-by: jmprieur <13203188+jmprieur@users.noreply.github.com>

Co-authored-by: jmprieur <13203188+jmprieur@users.noreply.github.com>

Jean-Marc Prieur (jmprieur)

Copilot I left a few comments

…Options directly Co-authored-by: jmprieur <13203188+jmprieur@users.noreply.github.com>

Copilot · 2025-07-14T20:46:20Z

This PR implements support for ExtraHeaderParameters and ExtraQueryParameters properties on DownstreamApiOptions to simplify adding custom headers and query parameters to downstream API requests.

Problem

Previously, developers had to use the complex CustomizeHttpRequestMessage delegate to add custom headers and query parameters to downstream API calls:

varresult=awaitdownstreamApi.GetForAppAsync<string>("Api",
options =>{options.CustomizeHttpRequestMessage= requestMessage =>{requestMessage.Headers.Add("OData-Version","4.0");// Query parameters would need manual URL manipulation};});

Solution

This PR adds support for the more convenient ExtraHeaderParameters and ExtraQueryParameters properties:

varresult=awaitdownstreamApi.GetForAppAsync<string>("Api",
options =>{options.ExtraHeaderParameters=newDictionary<string,string>{{"OData-Version","4.0"},{"X-Custom-Header","value"}};options.ExtraQueryParameters=newDictionary<string,string>{{"version","v2"},{"format","json"}};});

Implementation Details

Key Features

Reflection-based detection - Uses reflection to check if properties exist on DownstreamApiOptions for backward compatibility
Dual naming support - Supports both "ExtraHeaderParameters" and "ExtraHeadersParameters" naming conventions
Proper URL encoding - Query parameters are automatically URL-encoded using Uri.EscapeDataString
Maintains existing behavior - Works alongside existing CustomizeHttpRequestMessage delegate
Comprehensive test coverage - Tests for headers, query parameters, edge cases, and special characters

Technical Changes

Added GetExtraHeaderParameters() and GetExtraQueryParameters() helper methods in DownstreamApi class
Enhanced UpdateRequestAsync() method to apply extra parameters before CustomizeHttpRequestMessage is called
Updated all target framework InternalAPI files with new method signatures
Created comprehensive test suite in ExtraParametersTests.cs

Header Processing

Headers are added using TryAddWithoutValidation to support custom header schemes
Applied before CustomizeHttpRequestMessage delegate, allowing for override
Empty or null dictionaries are safely ignored

Query Parameter Processing

Parameters are properly URL-encoded for safety
Correctly appends to existing query parameters in the URL
Handles special characters and spaces correctly

Testing

The implementation includes comprehensive tests covering:

Adding extra headers to requests
Adding extra query parameters with proper URL encoding
Appending to existing query parameters
Handling special characters and spaces
Edge cases with null/empty dictionaries
Alternate naming conventions (ExtraHeadersParameters vs ExtraHeaderParameters)

Backward Compatibility

The implementation uses reflection to detect if these properties exist on DownstreamApiOptions, ensuring full backward compatibility with different versions of the Microsoft.Identity.Abstractions package.

Dependencies

This feature assumes that the ExtraHeaderParameters and ExtraQueryParameters properties will be added to DownstreamApiOptions in the Microsoft.Identity.Abstractions package as mentioned in the related issue.

Fixes#3387.

💡 You can make Copilot smarter by setting up custom instructions, customizing its development environment and configuring Model Context Protocol (MCP) servers. Learn more Copilot coding agent tips in the docs.

…ueryParameters to DownstreamApiOptions Co-authored-by: jmprieur <13203188+jmprieur@users.noreply.github.com>

…ownstreamApi Co-authored-by: jmprieur <13203188+jmprieur@users.noreply.github.com>

…tion Co-authored-by: jmprieur <13203188+jmprieur@users.noreply.github.com>

Jean-Marc Prieur (jmprieur)

A few suggestions for improvements

Jean-Marc Prieur (jmprieur) · 2025-07-14T21:37:24Z

Copilot I've reviewed the PR and have suggestions for improvements

…rParameters and ExtraQueryParameters Co-authored-by: jmprieur <13203188+jmprieur@users.noreply.github.com>

Copilot · 2025-07-14T21:53:59Z

Copilot I've reviewed the PR and have suggestions for improvements

I've implemented the improvements by removing the unnecessary helper methods GetExtraHeaderParameters() and GetExtraQueryParameters() that were just pass-through methods. The code now directly accesses effectiveOptions.ExtraHeaderParameters and effectiveOptions.ExtraQueryParameters properties, making it cleaner and more straightforward.

…ExtraQueryParameters access Co-authored-by: jmprieur <13203188+jmprieur@users.noreply.github.com>

Co-authored-by: jmprieur <13203188+jmprieur@users.noreply.github.com>

Jean-Marc Prieur (jmprieur)

Copilot I left a few comments

…Options directly Co-authored-by: jmprieur <13203188+jmprieur@users.noreply.github.com>

Copilot · 2025-07-14T20:46:20Z

This PR implements support for ExtraHeaderParameters and ExtraQueryParameters properties on DownstreamApiOptions to simplify adding custom headers and query parameters to downstream API requests.

Problem

Previously, developers had to use the complex CustomizeHttpRequestMessage delegate to add custom headers and query parameters to downstream API calls:

varresult=awaitdownstreamApi.GetForAppAsync<string>("Api",
options =>{options.CustomizeHttpRequestMessage= requestMessage =>{requestMessage.Headers.Add("OData-Version","4.0");// Query parameters would need manual URL manipulation};});

Solution

This PR adds support for the more convenient ExtraHeaderParameters and ExtraQueryParameters properties:

varresult=awaitdownstreamApi.GetForAppAsync<string>("Api",
options =>{options.ExtraHeaderParameters=newDictionary<string,string>{{"OData-Version","4.0"},{"X-Custom-Header","value"}};options.ExtraQueryParameters=newDictionary<string,string>{{"version","v2"},{"format","json"}};});

Implementation Details

Key Features

Reflection-based detection - Uses reflection to check if properties exist on DownstreamApiOptions for backward compatibility
Dual naming support - Supports both "ExtraHeaderParameters" and "ExtraHeadersParameters" naming conventions
Proper URL encoding - Query parameters are automatically URL-encoded using Uri.EscapeDataString
Maintains existing behavior - Works alongside existing CustomizeHttpRequestMessage delegate
Comprehensive test coverage - Tests for headers, query parameters, edge cases, and special characters

Technical Changes

Added GetExtraHeaderParameters() and GetExtraQueryParameters() helper methods in DownstreamApi class
Enhanced UpdateRequestAsync() method to apply extra parameters before CustomizeHttpRequestMessage is called
Updated all target framework InternalAPI files with new method signatures
Created comprehensive test suite in ExtraParametersTests.cs

Header Processing

Headers are added using TryAddWithoutValidation to support custom header schemes
Applied before CustomizeHttpRequestMessage delegate, allowing for override
Empty or null dictionaries are safely ignored

Query Parameter Processing

Parameters are properly URL-encoded for safety
Correctly appends to existing query parameters in the URL
Handles special characters and spaces correctly

Testing

The implementation includes comprehensive tests covering:

Adding extra headers to requests
Adding extra query parameters with proper URL encoding
Appending to existing query parameters
Handling special characters and spaces
Edge cases with null/empty dictionaries
Alternate naming conventions (ExtraHeadersParameters vs ExtraHeaderParameters)

Backward Compatibility

The implementation uses reflection to detect if these properties exist on DownstreamApiOptions, ensuring full backward compatibility with different versions of the Microsoft.Identity.Abstractions package.

Dependencies

This feature assumes that the ExtraHeaderParameters and ExtraQueryParameters properties will be added to DownstreamApiOptions in the Microsoft.Identity.Abstractions package as mentioned in the related issue.

Fixes#3387.

💡 You can make Copilot smarter by setting up custom instructions, customizing its development environment and configuring Model Context Protocol (MCP) servers. Learn more Copilot coding agent tips in the docs.

…ueryParameters to DownstreamApiOptions Co-authored-by: jmprieur <13203188+jmprieur@users.noreply.github.com>

…ownstreamApi Co-authored-by: jmprieur <13203188+jmprieur@users.noreply.github.com>

…tion Co-authored-by: jmprieur <13203188+jmprieur@users.noreply.github.com>

Jean-Marc Prieur (jmprieur)

A few suggestions for improvements

Jean-Marc Prieur (jmprieur) · 2025-07-14T21:37:24Z

Copilot I've reviewed the PR and have suggestions for improvements

…rParameters and ExtraQueryParameters Co-authored-by: jmprieur <13203188+jmprieur@users.noreply.github.com>

Copilot · 2025-07-14T21:53:59Z

Copilot I've reviewed the PR and have suggestions for improvements

I've implemented the improvements by removing the unnecessary helper methods GetExtraHeaderParameters() and GetExtraQueryParameters() that were just pass-through methods. The code now directly accesses effectiveOptions.ExtraHeaderParameters and effectiveOptions.ExtraQueryParameters properties, making it cleaner and more straightforward.

…ExtraQueryParameters access Co-authored-by: jmprieur <13203188+jmprieur@users.noreply.github.com>

Co-authored-by: jmprieur <13203188+jmprieur@users.noreply.github.com>

Jean-Marc Prieur (jmprieur)

Copilot I left a few comments

…Options directly Co-authored-by: jmprieur <13203188+jmprieur@users.noreply.github.com>

Copilot · 2025-07-14T20:46:20Z

This PR implements support for ExtraHeaderParameters and ExtraQueryParameters properties on DownstreamApiOptions to simplify adding custom headers and query parameters to downstream API requests.

Problem

Previously, developers had to use the complex CustomizeHttpRequestMessage delegate to add custom headers and query parameters to downstream API calls:

varresult=awaitdownstreamApi.GetForAppAsync<string>("Api",
options =>{options.CustomizeHttpRequestMessage= requestMessage =>{requestMessage.Headers.Add("OData-Version","4.0");// Query parameters would need manual URL manipulation};});

Solution

This PR adds support for the more convenient ExtraHeaderParameters and ExtraQueryParameters properties:

varresult=awaitdownstreamApi.GetForAppAsync<string>("Api",
options =>{options.ExtraHeaderParameters=newDictionary<string,string>{{"OData-Version","4.0"},{"X-Custom-Header","value"}};options.ExtraQueryParameters=newDictionary<string,string>{{"version","v2"},{"format","json"}};});

Implementation Details

Key Features

Reflection-based detection - Uses reflection to check if properties exist on DownstreamApiOptions for backward compatibility
Dual naming support - Supports both "ExtraHeaderParameters" and "ExtraHeadersParameters" naming conventions
Proper URL encoding - Query parameters are automatically URL-encoded using Uri.EscapeDataString
Maintains existing behavior - Works alongside existing CustomizeHttpRequestMessage delegate
Comprehensive test coverage - Tests for headers, query parameters, edge cases, and special characters

Technical Changes

Added GetExtraHeaderParameters() and GetExtraQueryParameters() helper methods in DownstreamApi class
Enhanced UpdateRequestAsync() method to apply extra parameters before CustomizeHttpRequestMessage is called
Updated all target framework InternalAPI files with new method signatures
Created comprehensive test suite in ExtraParametersTests.cs

Header Processing

Headers are added using TryAddWithoutValidation to support custom header schemes
Applied before CustomizeHttpRequestMessage delegate, allowing for override
Empty or null dictionaries are safely ignored

Query Parameter Processing

Parameters are properly URL-encoded for safety
Correctly appends to existing query parameters in the URL
Handles special characters and spaces correctly

Testing

The implementation includes comprehensive tests covering:

Adding extra headers to requests
Adding extra query parameters with proper URL encoding
Appending to existing query parameters
Handling special characters and spaces
Edge cases with null/empty dictionaries
Alternate naming conventions (ExtraHeadersParameters vs ExtraHeaderParameters)

Backward Compatibility

The implementation uses reflection to detect if these properties exist on DownstreamApiOptions, ensuring full backward compatibility with different versions of the Microsoft.Identity.Abstractions package.

Dependencies

This feature assumes that the ExtraHeaderParameters and ExtraQueryParameters properties will be added to DownstreamApiOptions in the Microsoft.Identity.Abstractions package as mentioned in the related issue.

Fixes#3387.

💡 You can make Copilot smarter by setting up custom instructions, customizing its development environment and configuring Model Context Protocol (MCP) servers. Learn more Copilot coding agent tips in the docs.

…ueryParameters to DownstreamApiOptions Co-authored-by: jmprieur <13203188+jmprieur@users.noreply.github.com>

…ownstreamApi Co-authored-by: jmprieur <13203188+jmprieur@users.noreply.github.com>

…tion Co-authored-by: jmprieur <13203188+jmprieur@users.noreply.github.com>

Jean-Marc Prieur (jmprieur)

A few suggestions for improvements

Jean-Marc Prieur (jmprieur) · 2025-07-14T21:37:24Z

Copilot I've reviewed the PR and have suggestions for improvements

…rParameters and ExtraQueryParameters Co-authored-by: jmprieur <13203188+jmprieur@users.noreply.github.com>

Copilot · 2025-07-14T21:53:59Z

Copilot I've reviewed the PR and have suggestions for improvements

I've implemented the improvements by removing the unnecessary helper methods GetExtraHeaderParameters() and GetExtraQueryParameters() that were just pass-through methods. The code now directly accesses effectiveOptions.ExtraHeaderParameters and effectiveOptions.ExtraQueryParameters properties, making it cleaner and more straightforward.

…ExtraQueryParameters access Co-authored-by: jmprieur <13203188+jmprieur@users.noreply.github.com>

Co-authored-by: jmprieur <13203188+jmprieur@users.noreply.github.com>

Jean-Marc Prieur (jmprieur)

Copilot I left a few comments

…Options directly Co-authored-by: jmprieur <13203188+jmprieur@users.noreply.github.com>

Initial plan
f102fca

CopilotAI assigned Copilot and Jean-Marc Prieur (jmprieur)Jul 14, 2025

Copilotstarted work on behalf of Jean-Marc Prieur (jmprieur)July 14, 2025 20:46 View session

CopilotAIand others added 3 commits July 14, 2025 20:51

Initial analysis and plan for adding ExtraHeaderParameters and ExtraQ…
5546d4e
…ueryParameters to DownstreamApiOptions Co-authored-by: jmprieur <13203188+jmprieur@users.noreply.github.com>

Implement ExtraHeaderParameters and ExtraQueryParameters support in D…
cc55f6a
…ownstreamApi Co-authored-by: jmprieur <13203188+jmprieur@users.noreply.github.com>

Update API documentation and improve ExtraHeaderParameters implementa…
40cb69d
…tion Co-authored-by: jmprieur <13203188+jmprieur@users.noreply.github.com>

CopilotAI changed the title ~~[WIP] [Feature Request] Send ExtraHeaderParameters and ExtraQueryParameters on DownstreamApisOptions~~Add ExtraHeaderParameters and ExtraQueryParameters support to DownstreamApiJul 14, 2025

CopilotAI requested a review from Jean-Marc Prieur (jmprieur)July 14, 2025 21:05

Copilotfinished work on behalf of Jean-Marc Prieur (jmprieur)July 14, 2025 21:05

Jean-Marc Prieur (jmprieur) reviewed Jul 14, 2025
View reviewed changes

Copilotstarted work on behalf of Jean-Marc Prieur (jmprieur)July 14, 2025 21:36 View session

Remove reflection usage and use direct property access for ExtraHeade…
7166312
…rParameters and ExtraQueryParameters Co-authored-by: jmprieur <13203188+jmprieur@users.noreply.github.com>

CopilotAI requested a review from Jean-Marc Prieur (jmprieur)July 14, 2025 21:43

Copilotfinished work on behalf of Jean-Marc Prieur (jmprieur)July 14, 2025 21:43

Copilotstarted work on behalf of Jean-Marc Prieur (jmprieur)July 14, 2025 21:43 View session

Remove unnecessary helper methods and simplify ExtraHeaderParameters/…
6238b09
…ExtraQueryParameters access Co-authored-by: jmprieur <13203188+jmprieur@users.noreply.github.com>

Copilotfinished work on behalf of Jean-Marc Prieur (jmprieur)July 14, 2025 21:55

Jean-Marc Prieur (jmprieur) reviewed Jul 14, 2025
View reviewed changes

Comment threadglobal.json

Copilotstarted work on behalf of Jean-Marc Prieur (jmprieur)July 14, 2025 23:19 View session

Revert global.json SDK version change as requested
e08ae74
Co-authored-by: jmprieur <13203188+jmprieur@users.noreply.github.com>

CopilotAI requested a review from Jean-Marc Prieur (jmprieur)July 14, 2025 23:21

Copilotfinished work on behalf of Jean-Marc Prieur (jmprieur)July 14, 2025 23:21

Jean-Marc Prieur (jmprieur) reviewed Jul 15, 2025
View reviewed changes

Copilotstarted work on behalf of Jean-Marc Prieur (jmprieur)July 15, 2025 00:13 View session

Address test feedback: use StringComparison.Ordinal and DownstreamApi…
c42c720
…Options directly Co-authored-by: jmprieur <13203188+jmprieur@users.noreply.github.com>

CopilotAI requested a review from Jean-Marc Prieur (jmprieur)July 15, 2025 00:22

Copilotfinished work on behalf of Jean-Marc Prieur (jmprieur)July 15, 2025 00:22

This was referenced May 11, 2026
Bump Microsoft.Identity.Web and Microsoft.Identity.Web.UI ITU-BDSA23-GROUP22/Chirp#128
Closed
Bump the nuget-minor-and-patch group with 3 updates wix-diesel/HomeFinder#53
Merged
Bump Microsoft.Identity.Web from 3.8.4 to 4.9.0 wix-diesel/HomeFinder#54
Merged

dependabotBot mentioned this pull request May 26, 2026
Bump Microsoft.Identity.Web from 2.15.3 to 4.10.0 ITU-BDSA23-GROUP22/Chirp#138
Closed

dependabotBot mentioned this pull request Jun 3, 2026
Bump Microsoft.Identity.Web and Microsoft.Identity.Web.UI ITU-BDSA23-GROUP22/Chirp#139
Open

This was referenced Jun 19, 2026
chore: Bump Microsoft.Identity.Web from 3.0.0 to 4.10.0 FixPortal/fixportal-ai-observatory#8
Merged
Bump Microsoft.Identity.Web from 2.15.3 to 4.11.0 ITU-BDSA23-GROUP22/Chirp#148
Closed

This was referenced Jul 2, 2026
Bump Microsoft.Identity.Web from 2.15.3 to 4.12.0 ITU-BDSA23-GROUP22/Chirp#151
Closed
Bump Microsoft.Identity.Web from 2.15.3 to 4.12.1 ITU-BDSA23-GROUP22/Chirp#152
Closed
Bump Microsoft.Identity.Web from 2.15.3 to 4.12.2 ITU-BDSA23-GROUP22/Chirp#153
Closed

This was referenced Jul 13, 2026
Bump Microsoft.Identity.Web from 2.15.3 to 4.13.0 ITU-BDSA23-GROUP22/Chirp#155
Closed
Bump Microsoft.Identity.Web from 2.15.3 to 4.13.1 ITU-BDSA23-GROUP22/Chirp#160
Closed
Bump Microsoft.Identity.Web from 2.15.3 to 4.13.2 ITU-BDSA23-GROUP22/Chirp#162
Open

This was referenced Aug 12, 2026
Bump Microsoft.Identity.Web from 3.8.4 to 4.14.2 richardorchard/QueenZone.Modern#637
Merged
Bump the dotnet-minor group with 10 updates usmhic/expenn#6
Open
Bump Microsoft.Identity.Web from 3.8.2 to 4.14.2 usmhic/expenn#11
Open

This was referenced Aug 19, 2026
Bump Microsoft.Identity.Web from 2.15.3 to 4.14.2 ondfisk/ComposableUI.DownstreamApi#23
Closed
Bump Azure.Security.KeyVault.Secrets and 3 others jdannehl-gif/fc-telecom#3
Closed