Sharing Groups

add_org_to_sharing_group async

add_org_to_sharing_group(auth: Annotated[Auth, Depends(authorize(HYBRID, [SHARING_GROUP]))], db: Annotated[Session, Depends(get_db)], id: int, body: AddOrgToSharingGroupBody) -> SharingGroupOrgSchema

Add an organisation to a sharing group.

Parameters:

Name	Type	Description	Default
auth	Annotated[Auth, Depends(authorize(HYBRID, [SHARING_GROUP]))]	Authentication details	required
db	Annotated[Session, Depends(get_db)]	Database session.	required
id	int	ID of the sharing group to add the organisation	required
body	AddOrgToSharingGroupBody	Request body containing organisation details	required

Returns:

Name	Type	Description
SharingGroupOrgSchema	SharingGroupOrg	Representation of the added organisation in the sharing group

add_org_to_sharing_group_legacy async

add_org_to_sharing_group_legacy(auth: Annotated[Auth, Depends(authorize(HYBRID, [SHARING_GROUP]))], db: Annotated[Session, Depends(get_db)], id: Annotated[int, Path(alias=sharingGroupId)], organisation_id: Annotated[int, Path(alias=organisationId)], body: AddOrgToSharingGroupLegacyBody = AddOrgToSharingGroupLegacyBody()) -> StandardStatusResponse

Add an organisation to a sharing group.

Parameters:

Name	Type	Description	Default
auth	Annotated[Auth, Depends(authorize(HYBRID, [SHARING_GROUP]))]	Authentication details	required
db	Annotated[Session, Depends(get_db)]	Database session	required
id	Annotated[int, Path(alias=sharingGroupId)]	ID of the sharing group to add the organisation	required
organisation_id	Annotated[int, Path(alias=organisationId)]	ID of the organisation to add	required
body	AddOrgToSharingGroupLegacyBody	Request body containing additional details	AddOrgToSharingGroupLegacyBody()

Returns:

Name	Type	Description
StandardStatusResponse	StandardStatusResponse	Response indicating success or failure

add_server_to_sharing_group async

add_server_to_sharing_group(auth: Annotated[Auth, Depends(authorize(HYBRID, [SHARING_GROUP]))], db: Annotated[Session, Depends(get_db)], id: int, body: AddServerToSharingGroupBody) -> dict

Add a server to a sharing group.

Parameters:

Name	Type	Description	Default
auth	Annotated[Auth, Depends(authorize(HYBRID, [SHARING_GROUP]))]	Authentication details	required
db	Annotated[Session, Depends(get_db)]	Database session	required
id	int	ID of the sharing group to add the server	required
body	AddServerToSharingGroupBody	Request body containing server details	required

Returns:

Type	Description
dict	Representation of the added server in the sharing group

add_server_to_sharing_group_legacy async

add_server_to_sharing_group_legacy(auth: Annotated[Auth, Depends(authorize(HYBRID, [SHARING_GROUP]))], db: Annotated[Session, Depends(get_db)], id: Annotated[int, Path(alias=sharingGroupId)], server_id: Annotated[int, Path(alias=serverId)], body: AddServerToSharingGroupLegacyBody = AddServerToSharingGroupLegacyBody()) -> StandardStatusResponse

Add a server to a sharing group.

Parameters:

Name	Type	Description	Default
auth	Annotated[Auth, Depends(authorize(HYBRID, [SHARING_GROUP]))]	Authentication details	required
db	Annotated[Session, Depends(get_db)]	Database session	required
id	Annotated[int, Path(alias=sharingGroupId)]	ID of the sharing group to add the server	required
server_id	Annotated[int, Path(alias=serverId)]	ID of the server to add	required
body	AddServerToSharingGroupLegacyBody	Request body containing additional details	AddServerToSharingGroupLegacyBody()

Returns:

Name	Type	Description
StandardStatusResponse	StandardStatusResponse	Response indicating success or failure

create_sharing_group async

create_sharing_group(auth: Annotated[Auth, Depends(authorize(HYBRID, [SHARING_GROUP]))], db: Annotated[Session, Depends(get_db)], body: CreateSharingGroupBody) -> dict

Add a new sharing group with given details.

Parameters:

Name	Type	Description	Default
auth	Annotated[Auth, Depends(authorize(HYBRID, [SHARING_GROUP]))]	Authentication details	required
db	Annotated[Session, Depends(get_db)]	Database session	required
body	CreateSharingGroupBody	Request body containing details for creating the sharing group	required

Returns:

Type	Description
dict	Details of the created sharing group

create_sharing_group_legacy async

create_sharing_group_legacy(auth: Annotated[Auth, Depends(authorize(HYBRID, [SHARING_GROUP]))], db: Annotated[Session, Depends(get_db)], body: CreateSharingGroupLegacyBody) -> dict

Add a new sharing group with given details.

Parameters:

Name	Type	Description	Default
auth	Annotated[Auth, Depends(authorize(HYBRID, [SHARING_GROUP]))]	Authentication details	required
db	Annotated[Session, Depends(get_db)]	Database session	required
body	CreateSharingGroupLegacyBody	Request body containing details for creating the sharing group	required

Returns:

Type	Description
dict	Representation of the created sharing group

delete_sharing_group async

delete_sharing_group(auth: Annotated[Auth, Depends(authorize(HYBRID, [SHARING_GROUP]))], db: Annotated[Session, Depends(get_db)], id: int) -> dict

Delete a specific sharing group.

Parameters:

Name	Type	Description	Default
auth	Annotated[Auth, Depends(authorize(HYBRID, [SHARING_GROUP]))]	Authentication details	required
db	Annotated[Session, Depends(get_db)]	Database session	required
id	int	ID of the sharing group to delete	required

Returns:

Type	Description
dict	Representation of the deleted sharing group

delete_sharing_group_legacy async

delete_sharing_group_legacy(auth: Annotated[Auth, Depends(authorize(HYBRID, [SHARING_GROUP]))], db: Annotated[Session, Depends(get_db)], id: Annotated[int, Path(alias=sharingGroupId)]) -> dict

Delete a specific sharing group.

Parameters:

Name	Type	Description	Default
auth	Annotated[Auth, Depends(authorize(HYBRID, [SHARING_GROUP]))]	Authentication details	required
db	Annotated[Session, Depends(get_db)]	Database session	required
id	Annotated[int, Path(alias=sharingGroupId)]	ID of the sharing group to delete	required

Returns:

Type	Description
dict	Representation of the deleted sharing group

get_all_sharing_groups async

get_all_sharing_groups(auth: Annotated[Auth, Depends(authorize(ALL, [SHARING_GROUP]))], db: Annotated[Session, Depends(get_db)]) -> GetSharingGroupsIndex

Retrieve a list of all sharing groups.

Parameters:

Name	Type	Description	Default
auth	Annotated[Auth, Depends(authorize(ALL, [SHARING_GROUP]))]	Authentication details	required
db	Annotated[Session, Depends(get_db)]	Database session	required

Returns:

Type	Description
GetSharingGroupsIndex	Representation of all sharing groups

get_sharing_group async

get_sharing_group(auth: Annotated[Auth, Depends(authorize(HYBRID, [SHARING_GROUP]))], db: Annotated[Session, Depends(get_db)], id: int | UUID) -> dict

Retrieve details of a specific sharing group.

Parameters:

Name	Type	Description	Default
auth	Annotated[Auth, Depends(authorize(HYBRID, [SHARING_GROUP]))]	Authentication details	required
db	Annotated[Session, Depends(get_db)]	Database session	required
id	int | UUID	ID of the sharing group to retrieve	required

Returns:

Type	Description
dict	Representation of the sharing group details

get_sharing_group_info async

get_sharing_group_info(auth: Annotated[Auth, Depends(authorize(HYBRID, [SHARING_GROUP]))], db: Annotated[Session, Depends(get_db)], id: int) -> dict

Details of a sharing group and org.count, user_count and created_by_email.

Parameters:

Name	Type	Description	Default
auth	Annotated[Auth, Depends(authorize(HYBRID, [SHARING_GROUP]))]	Authentication details	required
db	Annotated[Session, Depends(get_db)]	Database session	required
id	int	ID of the sharing group to retrieve additional information	required

Returns:

Type	Description
dict	Representation of the sharing group information

remove_org_from_sharing_group async

remove_org_from_sharing_group(auth: Annotated[Auth, Depends(authorize(HYBRID, [SHARING_GROUP]))], db: Annotated[Session, Depends(get_db)], id: int, organisation_id: Annotated[int, Path(alias=organisationId)]) -> dict

Remove an organisation from a sharing group

Parameters:

Name	Type	Description	Default
auth	Annotated[Auth, Depends(authorize(HYBRID, [SHARING_GROUP]))]	Authentication details	required
db	Annotated[Session, Depends(get_db)]	Database session.	required
id	int	ID of the sharing group to remove the organisation	required
organisation_id	Annotated[int, Path(alias=organisationId)]	ID of the organisation to remove	required

Returns:

Type	Description
dict	Representation of the removed organisation from the sharing group

remove_org_from_sharing_group_legacy async

remove_org_from_sharing_group_legacy(auth: Annotated[Auth, Depends(authorize(HYBRID, [SHARING_GROUP]))], db: Annotated[Session, Depends(get_db)], id: Annotated[int, Path(alias=sharingGroupId)], organisation_id: Annotated[int, Path(alias=organisationId)]) -> StandardStatusResponse

Remove an organisation from a sharing group.

Parameters:

Name	Type	Description	Default
auth	Annotated[Auth, Depends(authorize(HYBRID, [SHARING_GROUP]))]	Authentication details	required
db	Annotated[Session, Depends(get_db)]	Database session	required
id	Annotated[int, Path(alias=sharingGroupId)]	ID of the sharing group to remove the organisation from	required
organisation_id	Annotated[int, Path(alias=organisationId)]	ID of the organisation to remove	required

Returns:

Name	Type	Description
StandardStatusResponse	StandardStatusResponse	Response indicating success or failure

remove_server_from_sharing_group async

remove_server_from_sharing_group(auth: Annotated[Auth, Depends(authorize(HYBRID, [SHARING_GROUP]))], db: Annotated[Session, Depends(get_db)], id: int, server_id: Annotated[int, Path(alias=serverId)]) -> dict

Remove a server from a sharing group.

Parameters:

Name	Type	Description	Default
auth	Annotated[Auth, Depends(authorize(HYBRID, [SHARING_GROUP]))]	Authentication details	required
db	Annotated[Session, Depends(get_db)]	Database session	required
id	int	ID of the sharing group to remove the server	required
server_id	Annotated[int, Path(alias=serverId)]	ID of the server to remove	required

Returns:

Type	Description
dict	Representation of the removed server from the sharing group

remove_server_from_sharing_group_legacy async

remove_server_from_sharing_group_legacy(auth: Annotated[Auth, Depends(authorize(HYBRID, [SHARING_GROUP]))], db: Annotated[Session, Depends(get_db)], id: Annotated[int, Path(alias=sharingGroupId)], server_id: Annotated[int, Path(alias=serverId)]) -> StandardStatusResponse

Remove a server from a sharing group.

Parameters:

Name	Type	Description	Default
auth	Annotated[Auth, Depends(authorize(HYBRID, [SHARING_GROUP]))]	Authenticated user with ‘SHARING_GROUP’ permission	required
db	Annotated[Session, Depends(get_db)]	Database session	required
id	Annotated[int, Path(alias=sharingGroupId)]	ID of the sharing group to remove the server from	required
server_id	Annotated[int, Path(alias=serverId)]	ID of the server to remove	required

Returns:

Name	Type	Description
StandardStatusResponse	StandardStatusResponse	Response indicating success or failure

update_sharing_group async

update_sharing_group(auth: Annotated[Auth, Depends(authorize(HYBRID, [SHARING_GROUP]))], db: Annotated[Session, Depends(get_db)], id: int, body: UpdateSharingGroupBody) -> dict

Update an existing sharing group.

Parameters:

Name	Type	Description	Default
auth	Annotated[Auth, Depends(authorize(HYBRID, [SHARING_GROUP]))]	Authentication details	required
db	Annotated[Session, Depends(get_db)]	Database session	required
id	int	ID of the sharing group to update	required
body	UpdateSharingGroupBody	Request body containing updated details for the sharing group	required

Returns:

Type	Description
dict	Representation of the updated sharing group

update_sharing_group_legacy async

update_sharing_group_legacy(auth: Annotated[Auth, Depends(authorize(HYBRID, [SHARING_GROUP]))], db: Annotated[Session, Depends(get_db)], id: Annotated[int, Path(alias=sharingGroupId)], body: UpdateSharingGroupLegacyBody) -> ViewUpdateSharingGroupLegacyResponse

Update an existing sharing group by its ID.

Parameters:

Name	Type	Description	Default
auth	Annotated[Auth, Depends(authorize(HYBRID, [SHARING_GROUP]))]	Authentication details	required
db	Annotated[Session, Depends(get_db)]	Database session	required
id	Annotated[int, Path(alias=sharingGroupId)]	ID of the sharing group to update	required
body	UpdateSharingGroupLegacyBody	Request body containing updated details for the sharing group	required

Returns:

Name	Type	Description
ViewUpdateSharingGroupLegacyResponse	ViewUpdateSharingGroupLegacyResponse	Representation of the updated sharing group.

view_sharing_group_legacy async

view_sharing_group_legacy(auth: Annotated[Auth, Depends(authorize(HYBRID, [SHARING_GROUP]))], db: Annotated[Session, Depends(get_db)], id: Annotated[int | UUID, Path(alias=sharingGroupId)]) -> SingleSharingGroupResponse

Retrieve details of a specific sharing group by its ID.

Parameters:

Name	Type	Description	Default
auth	Annotated[Auth, Depends(authorize(HYBRID, [SHARING_GROUP]))]	Authentication details	required
db	Annotated[Session, Depends(get_db)]	Database session	required
id	Annotated[int | UUID, Path(alias=sharingGroupId)]	ID of the sharing group to retrieve	required

Returns:

Type	Description
SingleSharingGroupResponse	Representation of the sharing group details