Skip to content

Added extra_headers to ClientApplication #267

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

Closed
wants to merge 1 commit into from
Closed

Added extra_headers to ClientApplication #267

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
12 changes: 11 additions & 1 deletion msal/application.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -109,7 +109,7 @@ def __init__(
http_client=None,
verify=True, proxies=None, timeout=None,
client_claims=None, app_name=None, app_version=None,
client_capabilities=None):
client_capabilities=None, extra_headers=None):
"""Create an instance of application.

:param str client_id: Your app has a client_id after you register it on AAD.
Expand Down Expand Up @@ -191,6 +191,11 @@ def __init__(
:param app_version: (optional)
You can provide your application version for Microsoft telemetry purposes.
Default value is None, means it will not be passed to Microsoft.
:param dict extra_headers: (optional)
Allows you to pass extra headers to each OAuth client request,
adding them to the client session. msal uses requests.Session to requesting,
so more information you can find here:
https://requests.readthedocs.io/en/master/user/advanced/#session-objects
:param list[str] client_capabilities: (optional)
Allows configuration of one or more client capabilities, e.g. ["CP1"].

Expand Down Expand Up @@ -230,6 +235,7 @@ def __init__(
self.http_client, validate_authority=validate_authority)
# Here the self.authority is not the same type as authority in input
self.token_cache = token_cache or TokenCache()
self._extra_headers = extra_headers
self.client = self._build_client(client_credential, self.authority)
self.authority_groups = None

Expand All @@ -245,6 +251,10 @@ def _build_client(self, client_credential, authority):
default_headers['x-app-name'] = self.app_name
if self.app_version:
default_headers['x-app-ver'] = self.app_version
if self._extra_headers:
for k, v in self._extra_headers.items():
if k not in default_headers:
default_headers[k] = v
default_body = {"client_info": 1}
if isinstance(client_credential, dict):
assert ("private_key" in client_credential
Expand Down