flip_api.domain.interfaces.trust

Classes

IBasicTrust

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
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
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