:py:mod:`wfexs_backend.security_context`
========================================

.. py:module:: wfexs_backend.security_context

.. autodoc2-docstring:: wfexs_backend.security_context
   :allowtitles:

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

Classes
~~~~~~~

.. list-table::
   :class: autosummary longtable
   :align: left

   * - :py:obj:`SecurityContextVault <wfexs_backend.security_context.SecurityContextVault>`
     -

API
~~~

.. py:exception:: SecurityContextVaultException()
   :canonical: wfexs_backend.security_context.SecurityContextVaultException

   Bases: :py:obj:`wfexs_backend.common.AbstractWfExSException`

.. py:class:: SecurityContextVault(creds_config: Optional[SecurityContextConfigBlock] = None)
   :canonical: wfexs_backend.security_context.SecurityContextVault

   Bases: :py:obj:`abc.ABC`

   .. py:attribute:: SCHEME_PATTERN
      :canonical: wfexs_backend.security_context.SecurityContextVault.SCHEME_PATTERN
      :type: Final[Pattern[str]]
      :value: 'compile(...)'

      .. autodoc2-docstring:: wfexs_backend.security_context.SecurityContextVault.SCHEME_PATTERN

   .. py:attribute:: SECURITY_CONTEXT_SCHEMA
      :canonical: wfexs_backend.security_context.SecurityContextVault.SECURITY_CONTEXT_SCHEMA
      :type: Final[RelPath]
      :value: 'cast(...)'

      .. autodoc2-docstring:: wfexs_backend.security_context.SecurityContextVault.SECURITY_CONTEXT_SCHEMA

   .. py:method:: getContext(remote_file: str, contextName: Optional[str] = None) -> Optional[SecurityContextConfig]
      :canonical: wfexs_backend.security_context.SecurityContextVault.getContext

      .. autodoc2-docstring:: wfexs_backend.security_context.SecurityContextVault.getContext

   .. py:method:: ReadSecurityContextFile(securityContextsConfigFilename: pathlib.Path) -> Tuple[SecurityContextConfigBlock, Sequence[ValidationError]]
      :canonical: wfexs_backend.security_context.SecurityContextVault.ReadSecurityContextFile
      :classmethod:

      .. autodoc2-docstring:: wfexs_backend.security_context.SecurityContextVault.ReadSecurityContextFile

   .. py:method:: FromFile(securityContextsConfigFilename: pathlib.Path) -> wfexs_backend.security_context.SecurityContextVault
      :canonical: wfexs_backend.security_context.SecurityContextVault.FromFile
      :classmethod:

      .. autodoc2-docstring:: wfexs_backend.security_context.SecurityContextVault.FromFile