sharing

ProjectAccessRead

Bases: BaseModel

Project-access information for current user.

ATTRIBUTE	DESCRIPTION
is_owner	Whether current user is owner. TYPE: bool
permissions	Current user permissions. TYPE: str
owner_email	Email of project owner TYPE: str

Source code in fractal_server/app/schemas/v2/sharing.py

class ProjectAccessRead(BaseModel):
    """
    Project-access information for current user.

    Attributes:
        is_owner: Whether current user is owner.
        permissions: Current user permissions.
        owner_email: Email of project owner
    """

    is_owner: bool
    permissions: str
    owner_email: str

ProjectGuestCreate

Bases: BaseModel

Request body for project-sharing invitation.

ATTRIBUTE	DESCRIPTION
permissions	TYPE: ProjectPermissions

Source code in fractal_server/app/schemas/v2/sharing.py

class ProjectGuestCreate(BaseModel):
    """
    Request body for project-sharing invitation.

    Attributes:
        permissions:
    """

    permissions: ProjectPermissions

ProjectGuestRead

Bases: BaseModel

Information about a guest.

ATTRIBUTE	DESCRIPTION
email	Guest email. TYPE: str
is_verified	Project/guest verification status. TYPE: bool
permissions	Guest permissions for project. TYPE: str

Source code in fractal_server/app/schemas/v2/sharing.py

class ProjectGuestRead(BaseModel):
    """
    Information about a guest.

    Attributes:
        email: Guest email.
        is_verified: Project/guest verification status.
        permissions: Guest permissions for project.
    """

    email: str
    is_verified: bool
    permissions: str

ProjectGuestUpdate

Bases: BaseModel

Request body for updating permissions of an existing guest.

ATTRIBUTE	DESCRIPTION
permissions	New permissions for guest. TYPE: ProjectPermissions

Source code in fractal_server/app/schemas/v2/sharing.py

class ProjectGuestUpdate(BaseModel):
    """
    Request body for updating permissions of an existing guest.

    Attributes:
        permissions: New permissions for guest.
    """

    permissions: ProjectPermissions

ProjectInvitationRead

Bases: BaseModel

Info about a pending invitation.

ATTRIBUTE	DESCRIPTION
project_id	TYPE: int
project_name	TYPE: str
owner_email	TYPE: str
guest_permissions	TYPE: str

Source code in fractal_server/app/schemas/v2/sharing.py

class ProjectInvitationRead(BaseModel):
    """
    Info about a pending invitation.

    Attributes:
        project_id:
        project_name:
        owner_email:
        guest_permissions:
    """

    project_id: int
    project_name: str
    owner_email: str
    guest_permissions: str

ProjectPermissions

Bases: StrEnum

Available permissions for accessing Project Attributes: READ: WRITE: EXECUTE:

Source code in fractal_server/app/schemas/v2/sharing.py

class ProjectPermissions(StrEnum):
    """
    Available permissions for accessing Project
    Attributes:
        READ:
        WRITE:
        EXECUTE:
    """

    READ = "r"
    WRITE = "rw"
    EXECUTE = "rwx"