with_oidc#

ApiClientFactory.with_oidc(idp_session_configuration=None, oidc_configuration=None)#

Set up client authentication for use with OpenID Connect.

Parameters:
idp_session_configurationSessionConfiguration, optional

Additional configuration settings for the requests session when connected to the OpenID identity provider.

oidc_configurationOIDCConfiguration, optional

OpenID Connect provider settings. When omitted, authentication parameters are discovered from the API 401 response. When provided, explicit authorization_endpoint and token_endpoint values are used if set; otherwise well_known_url is used to discover them.

Returns:
OIDCSessionBuilder

Builder object to authenticate via OIDC.

Notes

OIDC Authentication requires the [oidc] extra to be installed.