flip_api.domain.interfaces.trust
================================

.. py:module:: flip_api.domain.interfaces.trust


Classes
-------

.. autoapisummary::

   flip_api.domain.interfaces.trust.IBasicTrust
   flip_api.domain.interfaces.trust.IAdminTrust
   flip_api.domain.interfaces.trust.ICreateTrust
   flip_api.domain.interfaces.trust.ICreatedTrust
   flip_api.domain.interfaces.trust.ITrustHealth
   flip_api.domain.interfaces.trust.ITrust
   flip_api.domain.interfaces.trust.ICreateImagingProject
   flip_api.domain.interfaces.trust.ICreatedImagingUser
   flip_api.domain.interfaces.trust.IAddedImagingUser
   flip_api.domain.interfaces.trust.ICreatedImagingProject
   flip_api.domain.interfaces.trust.ISesTemplateData
   flip_api.domain.interfaces.trust.ISesProjectAccessTemplateData


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

.. py:class:: IBasicTrust

   Bases: :py:obj:`pydantic.BaseModel`


   .. py:attribute:: id
      :type:  uuid.UUID


   .. py:attribute:: name
      :type:  str


   .. py:attribute:: code
      :type:  str | None
      :value: None



.. py:class:: IAdminTrust

   Bases: :py:obj:`pydantic.BaseModel`


   .. py:attribute:: id
      :type:  uuid.UUID


   .. py:attribute:: name
      :type:  str


   .. py:attribute:: code
      :type:  str | None
      :value: None



   .. py:attribute:: region
      :type:  str | None
      :value: None



   .. py:attribute:: created_at
      :type:  str | None
      :value: None



   .. py:attribute:: last_heartbeat
      :type:  str | None
      :value: None



   .. py:attribute:: project_count
      :type:  int
      :value: 0



.. py:class:: ICreateTrust

   Bases: :py:obj:`pydantic.BaseModel`


   .. py:attribute:: name
      :type:  str


   .. py:attribute:: code
      :type:  str


   .. py:attribute:: region
      :type:  str | None
      :value: None



.. py:class:: ICreatedTrust

   Bases: :py:obj:`pydantic.BaseModel`


   Response for POST /admin/trusts.

   `trust_api_key` and `trust_internal_service_key` are plaintext and are returned
   exactly once. The hub only stores the SHA-256 of the api key; the internal
   service key is not persisted (only used by trust-internal services).

   `fl_kit_slot` is the pre-provisioned FL participant identity assigned to this
   trust from the shared pool. The operator's containers mount the matching
   ``workspace/net-N/services/<fl_kit_slot>/`` dirs from flip-fl-base; this is the
   name the FL server sees on registration (independent of `name`).


   .. py:attribute:: id
      :type:  uuid.UUID


   .. py:attribute:: name
      :type:  str


   .. py:attribute:: code
      :type:  str | None
      :value: None



   .. py:attribute:: region
      :type:  str | None
      :value: None



   .. py:attribute:: created_at
      :type:  datetime.datetime | None
      :value: None



   .. py:attribute:: trust_api_key
      :type:  str


   .. py:attribute:: trust_internal_service_key
      :type:  str


   .. py:attribute:: fl_kit_slot
      :type:  str


   .. py:attribute:: fl_kit_slot_number
      :type:  int


.. py:class:: ITrustHealth

   Bases: :py:obj:`pydantic.BaseModel`


   .. py:attribute:: trust_id
      :type:  uuid.UUID


   .. py:attribute:: trust_name
      :type:  str


   .. py:attribute:: online
      :type:  bool


   .. py:attribute:: model_config


.. py:class:: ITrust

   Bases: :py:obj:`pydantic.BaseModel`


   .. py:attribute:: id
      :type:  uuid.UUID


   .. py:attribute:: name
      :type:  str


   .. py:attribute:: code
      :type:  str | None


   .. py:attribute:: fl_client_endpoint
      :type:  str | None


.. py:class:: ICreateImagingProject

   Bases: :py:obj:`pydantic.BaseModel`


   Represents a project on the central hub from which an imaging project is created on XNAT.


   .. py:attribute:: project_id
      :type:  uuid.UUID


   .. py:attribute:: trust_id
      :type:  uuid.UUID


   .. py:attribute:: project_name
      :type:  str


   .. py:attribute:: query
      :type:  str | None
      :value: None



   .. py:attribute:: users
      :type:  list[flip_api.domain.schemas.users.CognitoUser]
      :value: []



   .. py:attribute:: dicom_to_nifti
      :type:  bool
      :value: True



.. py:class:: ICreatedImagingUser

   Bases: :py:obj:`pydantic.BaseModel`


   Represents a user created on XNAT. Used to be called IImageUser in the old repo.


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


   .. py:attribute:: encrypted_password
      :type:  str


   .. py:attribute:: email
      :type:  pydantic.EmailStr


.. py:class:: IAddedImagingUser

   Bases: :py:obj:`pydantic.BaseModel`


   Represents an existing XNAT user who was added to an imaging project (no new credentials).


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


   .. py:attribute:: email
      :type:  pydantic.EmailStr


.. py:class:: ICreatedImagingProject

   Bases: :py:obj:`pydantic.BaseModel`


   Represents a project created on XNAT. Used to be called IImageId in the old repo.


   .. py:attribute:: imaging_project_id
      :type:  uuid.UUID


   .. py:attribute:: name
      :type:  str


   .. py:attribute:: created_users
      :type:  list[ICreatedImagingUser]


   .. py:attribute:: added_users
      :type:  list[IAddedImagingUser]
      :value: []



.. py:class:: ISesTemplateData

   Bases: :py:obj:`pydantic.BaseModel`


   .. py:attribute:: trust_name
      :type:  str


   .. py:attribute:: project_name
      :type:  str


   .. py:attribute:: project_id
      :type:  uuid.UUID


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


   .. py:attribute:: password
      :type:  str


.. py:class:: ISesProjectAccessTemplateData

   Bases: :py:obj:`pydantic.BaseModel`


   Template data for notifying existing users they've been added to a project (no password).


   .. py:attribute:: trust_name
      :type:  str


   .. py:attribute:: project_name
      :type:  str


   .. py:attribute:: project_id
      :type:  uuid.UUID


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