semantic-link-labs 0.12.8__py3-none-any.whl

sempy_labs/graph/_sensitivity_labels.py

@@ -0,0 +1,120 @@
+import pandas as pd
+from uuid import UUID
+from typing import Optional
+from sempy_labs._helper_functions import (
+    _base_api,
+    _create_dataframe,
+    _update_dataframe_datatypes,
+    _is_valid_uuid,
+)
+from sempy._utils._log import log
+
+
+@log
+def list_sensitivity_labels(user: Optional[str | UUID] = None) -> pd.DataFrame:
+    """
+    Get a list of `sensitivity label <https://learn.microsoft.com/graph/api/resources/security-sensitivitylabel>`_ objects associated with a user or organization.
+
+    This is a wrapper function for the following API: `List sensitivityLabels https://learn.microsoft.com/graph/api/security-informationprotection-list-sensitivitylabels>`_.
+
+    Service Principal Authentication is required (see `here <https://github.com/microsoft/semantic-link-labs/blob/main/notebooks/Service%20Principal.ipynb>`_ for examples).
+
+    Parameters
+    ----------
+    user : str | uuid.UUID
+        The user ID or user principal name.
+
+    Returns
+    -------
+    pandas.DataFrame
+        A pandas dataframe showing a list of `sensitivity label <https://learn.microsoft.com/graph/api/resources/security-sensitivitylabel>`_ objects associated with a user or organization.
+    """
+    from sempy_labs.graph import resolve_user_id
+
+    url = "/security/informationProtection/sensitivityLabels"
+
+    if user is not None:
+        user_id = resolve_user_id(user=user)
+        url = f"users/{user_id}{url}"
+
+    result = _base_api(request=url, client="graph").json()
+
+    columns = {
+        "Sensitivity Label Id": "str",
+        "Sensitivity Label Name": "str",
+        "Description": "str",
+        "Color": "str",
+        "Sensitivity": "int",
+        "Tooltip": "str",
+        "Is Active": "bool",
+        "Is Appliable": "bool",
+        "Has Protection": "bool",
+        "Parent Sensitivity Label Id": "str",
+        "Parent Sensitivity Label Name": "str",
+    }
+    df = _create_dataframe(columns=columns)
+
+    rows = []
+    for item in result.get("value", []):
+        row = {
+            "Sensitivity Label Id": item.get("id"),
+            "Sensitivity Label Name": item.get("name"),
+            "Description": item.get("description"),
+            "Color": item.get("color"),
+            "Sensitivity": item.get("sensitivity"),
+            "Tooltip": item.get("tooltip"),
+            "Is Active": item.get("isActive"),
+            "Is Appliable": item.get("isAppliable"),
+            "Has Protection": item.get("hasProtection"),
+            "Parent Sensitivity Label Id": (
+                item.get("parent", {}).get("id") if item.get("parent") else None
+            ),
+            "Parent Sensitivity Label Name": (
+                item.get("parent", {}).get("name") if item.get("parent") else None
+            ),
+        }
+        rows.append(row)
+
+    if rows:
+        df = pd.DataFrame(rows, columns=list(columns.keys()))
+        _update_dataframe_datatypes(dataframe=df, column_map=columns)
+
+    return df
+
+
+@log
+def resolve_sensitivity_label_id(
+    label: str | UUID, user: Optional[str | UUID] = None
+) -> UUID | None:
+    """
+    Resolve a sensitivity label name or ID to its corresponding sensitivity label ID.
+
+    Service Principal Authentication is required (see `here <https://github.com/microsoft/semantic-link-labs/blob/main/notebooks/Service%20Principal.ipynb>`_ for examples).
+
+    Parameters
+    ----------
+    label : str | uuid.UUID
+        The name or ID of the sensitivity label.
+    user : str | uuid.UUID, default=None
+        The user ID or user principal name.
+
+    Returns
+    -------
+    uuid.UUID | None
+        The ID of the sensitivity label if found, otherwise None.
+    """
+
+    if _is_valid_uuid(label):
+        return str(label)
+
+    df = list_sensitivity_labels(user=user)
+
+    if df.empty:
+        return None
+
+    # Try to find the label by name
+    label_row = df[df["Sensitivity Label Name"] == label]
+    if not label_row.empty:
+        return label_row["Sensitivity Label Id"].iloc[0]
+
+    return None

sempy_labs/graph/_teams.py

@@ -0,0 +1,125 @@
+import pandas as pd
+from uuid import UUID
+from sempy._utils._log import log
+from sempy_labs._helper_functions import (
+    _base_api,
+    _create_dataframe,
+    _update_dataframe_datatypes,
+)
+
+
+@log
+def list_teams() -> pd.DataFrame:
+    """
+    Shows a list of teams and their properties.
+
+    This is a wrapper function for the following API: `List teams <https://learn.microsoft.com/graph/api/teams-list>`_.
+
+    Service Principal Authentication is required (see `here <https://github.com/microsoft/semantic-link-labs/blob/main/notebooks/Service%20Principal.ipynb>`_ for examples).
+
+    Returns
+    -------
+    pandas.DataFrame
+        A pandas dataframe showing a list of teams and their properties.
+    """
+
+    result = _base_api(request="teams", client="graph", uses_pagination=True)
+
+    columns = {
+        "Team Id": "str",
+        "Team Name": "str",
+        "Description": "str",
+        "Creation Date Time": "datetime",
+        "Classification": "str",
+        "Specialization": "str",
+        "Visibility": "str",
+        "Web Url": "str",
+        "Archived": "bool",
+        "Favorite By Me": "bool",
+        "Discoverable By Me": "bool",
+        "Member Count": "int_fillna",
+    }
+
+    df = _create_dataframe(columns=columns)
+
+    rows = []
+    for r in result:
+        for v in r.get("value", []):
+            rows.append(
+                {
+                    "Team Id": v.get("id"),
+                    "Team Name": v.get("displayName"),
+                    "Description": v.get("description"),
+                    "Creation Date Time": v.get("createdDateTime"),
+                    "Classification": v.get("classification"),
+                    "Specialization": v.get("specialization"),
+                    "Visibility": v.get("visibility"),
+                    "Web Url": v.get("webUrl"),
+                    "Archived": v.get("isArchived"),
+                    "Favorite By Me": v.get("isFavoriteByMe"),
+                    "Discoverable By Me": v.get("isDiscoverableByMe"),
+                    "Member Count": v.get("memberCount"),
+                }
+            )
+
+    if rows:
+        df = pd.DataFrame(rows, columns=list(columns.keys()))
+        _update_dataframe_datatypes(dataframe=df, column_map=columns)
+
+    return df
+
+
+@log
+def list_chats(user: str | UUID) -> pd.DataFrame:
+    """
+    In progress...
+    """
+
+    from sempy_labs.graph._users import resolve_user_id
+
+    user_id = resolve_user_id(user=user)
+    result = _base_api(request=f"users/{user_id}/chats", client="graph").json()
+
+    columns = {
+        "Chat Id": "str",
+        "Type": "str",
+        "Members": "str",
+    }
+
+    df = _create_dataframe(columns=columns)
+
+    rows = []
+    for v in result.get("value"):
+        rows.append(
+            {
+                "Chat Id": v.get("id"),
+                "Type": v.get("chatType"),
+                "Members": v.get("members"),
+            }
+        )
+
+    if rows:
+        df = pd.DataFrame(rows, columns=list(columns.keys()))
+
+    return df
+
+
+@log
+def send_teams_message(chat_id: str, message: str):
+    """
+    In progress...
+    """
+
+    payload = {
+        "body": {
+            "content": message,
+        }
+    }
+
+    _base_api(
+        request=f"chats/{chat_id}/messages",
+        client="graph",
+        method="post",
+        payload=payload,
+        status_codes=201,
+    )

sempy_labs/graph/_user_licenses.py

@@ -0,0 +1,96 @@
+from uuid import UUID
+import sempy_labs._icons as icons
+from typing import List, Optional
+from sempy_labs._helper_functions import (
+    _base_api,
+)
+from sempy._utils._log import log
+from sempy_labs.graph._users import resolve_user_id
+
+
+@log
+def add_user_license(
+    user: str | UUID, sku_id: UUID, disabled_plans: Optional[UUID | List[UUID]] = None
+):
+    """
+    Assigns a license to a user.
+
+    This is a wrapper function for the following API: `user: assignLicense <https://learn.microsoft.com/graph/api/user-assignlicense>`_.
+
+    Service Principal Authentication is required (see `here <https://github.com/microsoft/semantic-link-labs/blob/main/notebooks/Service%20Principal.ipynb>`_ for examples).
+
+    Parameters
+    ----------
+    user : str | uuid.UUID
+        The user ID or user principal name.
+    sku_id : uuid.UUID
+        The SKU ID of the license to assign.
+    disabled_plans : Optional[uuid.UUID | List[uuid.UUID]], default=None
+        A single service plan ID or a list of service plan IDs to disable within the assigned license.
+    """
+
+    user_id = resolve_user_id(user)
+
+    payload = {
+        "addLicenses": [
+            {
+                "skuId": sku_id,
+            },
+        ],
+        "removeLicenses": [],
+    }
+
+    if disabled_plans:
+        if isinstance(disabled_plans, str):
+            disabled_plans = [disabled_plans]
+        payload["addLicenses"][0]["disabledPlans"] = disabled_plans
+
+    _base_api(
+        request=f"users/{user_id}/assignLicense",
+        client="graph",
+        method="post",
+        payload=payload,
+    )
+
+    print(
+        f"{icons.green_dot} The '{sku_id}' license has been assigned to the user '{user}'."
+    )
+
+
+@log
+def remove_user_license(user: str | UUID, sku_ids: UUID | List[UUID]):
+    """
+    Removes a license from a user.
+
+    This is a wrapper function for the following API: `user: assignLicense <https://learn.microsoft.com/graph/api/user-assignlicense>`_.
+
+    Service Principal Authentication is required (see `here <https://github.com/microsoft/semantic-link-labs/blob/main/notebooks/Service%20Principal.ipynb>`_ for examples).
+
+    Parameters
+    ----------
+    user : str | uuid.UUID
+        The user ID or user principal name.
+    sku_id : uuid.UUID
+        The SKU ID of the license to remove.
+    """
+
+    user_id = resolve_user_id(user)
+
+    if isinstance(sku_ids, str):
+        sku_ids = [sku_ids]
+
+    payload = {
+        "addLicenses": [],
+        "removeLicenses": sku_ids,
+    }
+
+    _base_api(
+        request=f"users/{user_id}/assignLicense",
+        client="graph",
+        method="post",
+        payload=payload,
+    )
+
+    print(
+        f"{icons.green_dot} The '{', '.join([str(s) for s in sku_ids])}' license(s) have been removed from the user '{user}'."
+    )