user.auth.clients.oidc
======================

.. py:module:: user.auth.clients.oidc


Classes
-------

.. autoapisummary::

   user.auth.clients.oidc.OIDCAttributes
   user.auth.clients.oidc.OIDCClient
   user.auth.clients.oidc.OIDCConnections


Module Contents
---------------

.. py:class:: OIDCAttributes

   Holds the expected OIDC claims.

   These claims may either be included in the JWT id token
   or in the response to the user endpoint


   .. py:attribute:: source_id
      :type:  str


   .. py:attribute:: username
      :type:  str


   .. py:attribute:: first_name
      :type:  str


   .. py:attribute:: last_name
      :type:  str


   .. py:attribute:: group
      :type:  str


   .. py:attribute:: preferred_username
      :type:  str


   .. py:method:: from_cfg(cfg: dict[str, Any]) -> Self
      :classmethod:



.. py:class:: OIDCClient

   .. py:attribute:: issuer
      :type:  str


   .. py:attribute:: client_id
      :type:  str


   .. py:attribute:: client_secret
      :type:  str


   .. py:attribute:: button_text
      :type:  str


   .. py:attribute:: attributes
      :type:  OIDCAttributes


   .. py:attribute:: primary
      :type:  bool


   .. py:attribute:: scope
      :type:  list[str]


   .. py:attribute:: fixed_metadata
      :type:  dict[str, Any]


   .. py:attribute:: _provider_metadata
      :type:  dict[str, dict[str, Any]]


   .. py:method:: session(provider: onegov.user.auth.provider.OIDCProvider, request: onegov.core.request.CoreRequest, *, with_openid_scope: bool = False) -> requests_oauthlib.OAuth2Session

      Returns a requests session tied to a OAuth2 client 



   .. py:method:: metadata(request: onegov.core.request.CoreRequest) -> dict[str, Any]


   .. py:method:: validate_token(request: onegov.core.request.CoreRequest, token: dict[str, Any]) -> dict[str, Any]


.. py:class:: OIDCConnections

   .. py:attribute:: connections
      :type:  dict[str, OIDCClient]


   .. py:method:: client(app: onegov.user.auth.provider.HasApplicationIdAndNamespace) -> OIDCClient | None


   .. py:method:: from_cfg(config: dict[str, Any]) -> Self
      :classmethod: