Skip to content

Group

Definition of /auth/group/ routes

FUNCTION DESCRIPTION
delete_single_group

Delete a user group.

Attributes

Classes

Functions:

delete_single_group(group_id, user=Depends(current_superuser_act), db=Depends(get_async_db)) async

Delete a user group.

If FRACTAL_DEFAULT_GROUP_NAME="All", a group named "All" cannot be deleted. If FRACTAL_DEFAULT_GROUP_NAME=None, any group can be deleted.

Source code in fractal_server/app/routes/auth/group.py 
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
@router_group.delete("/group/{group_id}/", status_code=204)
async def delete_single_group(
    group_id: int,
    user: UserOAuth = Depends(current_superuser_act),
    db: AsyncSession = Depends(get_async_db),
) -> Response:
    """
    Delete a user group.

    If `FRACTAL_DEFAULT_GROUP_NAME="All"`, a group named `"All"` cannot be
    deleted. If `FRACTAL_DEFAULT_GROUP_NAME=None`, any group can be deleted.
    """
    settings = Inject(get_settings)
    group = await _usergroup_or_404(group_id, db)

    if group.name == settings.FRACTAL_DEFAULT_GROUP_NAME:
        raise HTTPException(
            status_code=status.HTTP_422_UNPROCESSABLE_CONTENT,
            detail=(
                "Cannot delete default UserGroup "
                f"'{settings.FRACTAL_DEFAULT_GROUP_NAME}'."
            ),
        )

    await db.delete(group)
    await db.commit()

    return Response(status_code=status.HTTP_204_NO_CONTENT)