flip_api.domain.interfaces.trust

Classes

`IBasicTrust`
`IAdminTrust`
`ICreateTrust`
`ICreatedTrust`	Response for POST /admin/trusts.
`ITrustHealth`
`ITrust`
`ICreateImagingProject`	Represents a project on the central hub from which an imaging project is created on XNAT.
`ICreatedImagingUser`	Represents a user created on XNAT. Used to be called IImageUser in the old repo.
`IAddedImagingUser`	Represents an existing XNAT user who was added to an imaging project (no new credentials).
`ICreatedImagingProject`	Represents a project created on XNAT. Used to be called IImageId in the old repo.
`ISesTemplateData`
`ISesProjectAccessTemplateData`	Template data for notifying existing users they've been added to a project (no password).

Module Contents

class flip_api.domain.interfaces.trust.IBasicTrust

Bases: pydantic.BaseModel

id: uuid.UUID

name: str

code: str | None = None

class flip_api.domain.interfaces.trust.IAdminTrust

Bases: pydantic.BaseModel

id: uuid.UUID

name: str

code: str | None = None

region: str | None = None

created_at: str | None = None

last_heartbeat: str | None = None

project_count: int = 0

class flip_api.domain.interfaces.trust.ICreateTrust

Bases: pydantic.BaseModel

name: str

code: str

region: str | None = None

class flip_api.domain.interfaces.trust.ICreatedTrust

Bases: 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).

id: uuid.UUID

name: str

code: str | None = None

region: str | None = None

created_at: datetime.datetime | None = None

trust_api_key: str

trust_internal_service_key: str

fl_kit_slot: str

fl_kit_slot_number: int

class flip_api.domain.interfaces.trust.ITrustHealth

Bases: pydantic.BaseModel

trust_id: uuid.UUID

trust_name: str

online: bool

model_config

class flip_api.domain.interfaces.trust.ITrust

Bases: pydantic.BaseModel

id: uuid.UUID

name: str

code: str | None

fl_client_endpoint: str | None

class flip_api.domain.interfaces.trust.ICreateImagingProject

Bases: pydantic.BaseModel

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

project_id: uuid.UUID

trust_id: uuid.UUID

project_name: str

query: str | None = None

users: list[flip_api.domain.schemas.users.CognitoUser] = []

dicom_to_nifti: bool = True

class flip_api.domain.interfaces.trust.ICreatedImagingUser

Bases: pydantic.BaseModel

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

username: str

encrypted_password: str

email: pydantic.EmailStr

class flip_api.domain.interfaces.trust.IAddedImagingUser

Bases: pydantic.BaseModel

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

username: str

email: pydantic.EmailStr

class flip_api.domain.interfaces.trust.ICreatedImagingProject

Bases: pydantic.BaseModel

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

imaging_project_id: uuid.UUID

name: str

created_users: list[ICreatedImagingUser]

added_users: list[IAddedImagingUser] = []

class flip_api.domain.interfaces.trust.ISesTemplateData

Bases: pydantic.BaseModel

trust_name: str

project_name: str

project_id: uuid.UUID

username: str

password: str

class flip_api.domain.interfaces.trust.ISesProjectAccessTemplateData

Bases: pydantic.BaseModel

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

trust_name: str

project_name: str

project_id: uuid.UUID

username: str