Skip to content

Commit

Permalink
docs: Added missing parameters in connection doc
Browse files Browse the repository at this point in the history
  • Loading branch information
davidblain-infrabel committed Jan 24, 2025
1 parent d4fd147 commit f66b09f
Showing 1 changed file with 40 additions and 1 deletion.
Original file line number Diff line number Diff line change
Expand Up @@ -68,11 +68,23 @@ Authority


Scopes
The ``scopes`` scopes parameter specifies the permissions or access rights that your application is requesting for a connection.
The ``scopes`` parameter specifies the permissions or access rights that your application is requesting for a connection.
These permissions define what resources or data your application can access on behalf of the user or application.
Default value is ``https://graph.microsoft.com/.default``.


Certificate path
The ``certificate_path`` parameter specifies the filepath where the certificate is located.
Both ``certificate_path`` and ``certificate_data`` parameter cannot be used together, they should be mutually exclusive.
Default value is None.


Certificate data
The ``certificate_date`` parameter specifies the certificate as a string.
Both ``certificate_path`` and ``certificate_data`` parameter cannot be used together, they should be mutually exclusive.
Default value is None.


Disable instance discovery
The ``disable_instance_discovery`` parameter determines whether MSAL should validate and discover Azure AD endpoints dynamically during runtime.
Default value is False (e.g. disabled).
Expand All @@ -83,6 +95,33 @@ Allowed hosts
This parameter is particularly useful for enhancing security and controlling which endpoints the authentication provider interacts with.


Proxies
The ``proxies`` parameter is used to define a dict for the ``http`` and ``https`` schema, the ``no`` key can be use to define hosts not to be used by the proxy.
Default value is None.


Verify environment
The ``verify`` parameter specifies whether SSL certificates should be verified when making HTTPS requests.
By default, ``verify`` parameter is set to True. This means that the `httpx <https://www.python-httpx.org>`_ library will verify the SSL certificate presented by the server to ensure:

- The certificate is valid and trusted.
- The certificate matches the hostname of the server.
- The certificate has not expired or been revoked.

Setting ``verify`` to False disables SSL certificate verification. This is typically used in development or testing environments when working with self-signed certificates or servers without valid certificates.


Trust environment
The ``trust_env`` parameter determines whether or not the library should use environment variables for configuration when making HTTP/HTTPS requests.
By default, ``trust_env`` parameter is set to True. This means the `httpx <https://www.python-httpx.org>`_ library will automatically trust and use environment variables for proxy configuration, SSL settings, and authentication.


Base URL
The ``base_url`` parameter allows you to override the default base url used to make it requests, namely ``https://graph.microsoft.com/``.
This can be useful if you want to use the MSGraphAsyncOperator to call other Microsoft REST API's like Sharepoint or PowerBI.
Default value is None.


.. raw:: html

<div align="center" style="padding-bottom:10px">
Expand Down

0 comments on commit f66b09f

Please sign in to comment.