group

Group CRUD endpoint.

create_group(*, group, current_user)

Create a MLTE group.

Parameters:

Name	Type	Description	Default
group	Group	The group to create	required

Returns:

Type	Description
Group	The created group

Source code in mlte/backend/api/endpoints/group.py

@router.post("")
def create_group(
    *,
    group: Group,
    current_user: AuthorizedUser,
) -> Group:
    """
    Create a MLTE group.
    :param group: The group to create
    :return: The created group
    """
    with state_stores.user_store_session() as user_store:
        try:
            return user_store.group_mapper.create(group)
        except errors.ErrorAlreadyExists as e:
            raise HTTPException(
                status_code=codes.ALREADY_EXISTS, detail=f"{e} already exists."
            )
        except Exception as e:
            raise_http_internal_error(e)

delete_group(*, group_name, current_user)

Delete a MLTE group.

Parameters:

Name	Type	Description	Default
group_name	str	The group name	required

Returns:

Type	Description
Group	The deleted group

Source code in mlte/backend/api/endpoints/group.py

@router.delete("/{group_name}")
def delete_group(
    *,
    group_name: str,
    current_user: AuthorizedUser,
) -> Group:
    """
    Delete a MLTE group.
    :param group_name: The group name
    :return: The deleted group
    """
    with state_stores.user_store_session() as user_store:
        try:
            return user_store.group_mapper.delete(group_name)
        except errors.ErrorNotFound as e:
            raise HTTPException(
                status_code=codes.NOT_FOUND, detail=f"{e} not found."
            )
        except Exception as e:
            raise_http_internal_error(e)

edit_group(*, group, current_user)

Edit a MLTE group.

Parameters:

Name	Type	Description	Default
group	Group	The group to edit	required

Returns:

Type	Description
Group	The edited group

Source code in mlte/backend/api/endpoints/group.py

@router.put("")
def edit_group(
    *,
    group: Group,
    current_user: AuthorizedUser,
) -> Group:
    """
    Edit a MLTE group.
    :param group: The group to edit
    :return: The edited group
    """
    with state_stores.user_store_session() as user_store:
        try:
            return user_store.group_mapper.edit(group)
        except errors.ErrorNotFound as e:
            raise HTTPException(
                status_code=codes.NOT_FOUND, detail=f"{e} not found."
            )
        except Exception as e:
            raise_http_internal_error(e)

list_group_details(current_user)

List MLTE group, with details for each group.

Returns:

Type	Description
List[Group]	A collection of groups with their details.

Source code in mlte/backend/api/endpoints/group.py

@router.get("s/details")
def list_group_details(
    current_user: AuthorizedUser,
) -> List[Group]:
    """
    List MLTE group, with details for each group.
    :return: A collection of groups with their details.
    """
    with state_stores.user_store_session() as user_store:
        try:
            return user_store.group_mapper.list_details()
        except Exception as e:
            raise_http_internal_error(e)

list_groups(current_user)

List MLTE group.

Returns:

Type	Description
List[str]	A collection of group names

Source code in mlte/backend/api/endpoints/group.py

@router.get("")
def list_groups(
    current_user: AuthorizedUser,
) -> List[str]:
    """
    List MLTE group.
    :return: A collection of group names
    """
    with state_stores.user_store_session() as user_store:
        try:
            return user_store.group_mapper.list()
        except Exception as e:
            raise_http_internal_error(e)

list_permission_details(current_user)

List MLTE permissions, with details.

Returns:

Type	Description
List[Permission]	A collection of permissions, with details.

Source code in mlte/backend/api/endpoints/group.py

@router.get("s/permissions/details")
def list_permission_details(
    current_user: AuthorizedUser,
) -> List[Permission]:
    """
    List MLTE permissions, with details.
    :return: A collection of permissions, with details.
    """
    with state_stores.user_store_session() as user_store:
        try:
            return user_store.permission_mapper.list_details()
        except Exception as e:
            raise_http_internal_error(e)

list_permissions(current_user)

List MLTE permissions.

Returns:

Type	Description
List[str]	A collection of permissions

Source code in mlte/backend/api/endpoints/group.py

@router.get("s/permissions")
def list_permissions(
    current_user: AuthorizedUser,
) -> List[str]:
    """
    List MLTE permissions.
    :return: A collection of permissions
    """
    with state_stores.user_store_session() as user_store:
        try:
            return user_store.permission_mapper.list()
        except Exception as e:
            raise_http_internal_error(e)

read_group(*, group_name, current_user)

Read a MLTE group.

Parameters:

Name	Type	Description	Default
group_name	str	The group name	required

Returns:

Type	Description
Group	The read group

Source code in mlte/backend/api/endpoints/group.py

@router.get("/{group_name}")
def read_group(
    *,
    group_name: str,
    current_user: AuthorizedUser,
) -> Group:
    """
    Read a MLTE group.
    :param group_name: The group name
    :return: The read group
    """
    with state_stores.user_store_session() as user_store:
        try:
            return user_store.group_mapper.read(group_name)
        except errors.ErrorNotFound as e:
            raise HTTPException(
                status_code=codes.NOT_FOUND, detail=f"{e} not found."
            )
        except Exception as e:
            raise_http_internal_error(e)

read_permission(*, permission_str, current_user)

Read a permission, regardless of whether it is assigned to a group or not.

Returns:

Type	Description
Permission	A permission

Source code in mlte/backend/api/endpoints/group.py

@router.get("s/permission/{permission_str}")
def read_permission(
    *,
    permission_str: str,
    current_user: AuthorizedUser,
) -> Permission:
    """
    Read a permission, regardless of whether it is assigned to a group or not.
    :return: A permission
    """
    with state_stores.user_store_session() as user_store:
        try:
            return user_store.permission_mapper.read(permission_str)
        except Exception as e:
            raise_http_internal_error(e)