Office365-REST-Python-Client 2.5.5__py3-none-any.whl → 2.5.6__py3-none-any.whl

office365/directory/policies/authorization.py

@@ -1,3 +1,6 @@
+from typing import Optional
+
+from office365.directory.permissions.default_user_role import DefaultUserRolePermissions
 from office365.directory.policies.base import PolicyBase
 
 
@@ -8,8 +11,52 @@ class AuthorizationPolicy(PolicyBase):
 
     @property
     def allowed_to_sign_up_email_based_subscriptions(self):
+        # type: () -> Optional[bool]
+        """Indicates whether a user can join the tenant by email validation."""
+        return self.properties.get("allowedToSignUpEmailBasedSubscriptions", None)
+
+    @property
+    def allowed_to_use_sspr(self):
+        # type: () -> Optional[bool]
+        """Indicates whether users can use the Self-Service Password Reset feature on the tenant."""
+        return self.properties.get("allowedToUseSSPR", None)
+
+    @property
+    def allow_email_verified_users_to_join_organization(self):
+        # type: () -> Optional[bool]
+        """Indicates whether a user can join the tenant by email validation."""
+        return self.properties.get("allowEmailVerifiedUsersToJoinOrganization", None)
+
+    @property
+    def allow_invites_from(self):
+        # type: () -> Optional[str]
+        """Indicates who can invite external users to the organization.
+        Possible values are: none, adminsAndGuestInviters, adminsGuestInvitersAndAllMembers, everyone.
+        everyone is the default setting for all cloud environments except US Government.
         """
-        Indicates whether a user can join the tenant by email validation.
-        :rtype: bool
+        return self.properties.get("allowInvitesFrom", None)
+
+    @property
+    def allow_user_consent_for_risky_apps(self):
+        # type: () -> Optional[bool]
+        """Indicates whether user consent for risky apps is allowed.
+        We recommend keeping allowUserConsentForRiskyApps as false. Default value is false.
         """
-        return self.properties.get("allowedToSignUpEmailBasedSubscriptions", None)
+        return self.properties.get("allowUserConsentForRiskyApps", None)
+
+    @property
+    def block_msol_powershell(self):
+        # type: () -> Optional[bool]
+        """To disable the use of MSOL PowerShell, set this property to true. This also disables user-based access to
+        the legacy service endpoint used by MSOL PowerShell. This doesn't affect Microsoft Entra Connect
+        or Microsoft Graph.
+        """
+        return self.properties.get("blockMsolPowerShell", None)
+
+    @property
+    def default_user_role_permissions(self):
+        # type: () -> Optional[DefaultUserRolePermissions]
+        """Specifies certain customizable permissions for default user role."""
+        return self.properties.get(
+            "defaultUserRolePermissions", DefaultUserRolePermissions()
+        )

office365/directory/policies/permission_grant.py

@@ -17,6 +17,7 @@ class PermissionGrantPolicy(PolicyBase):
 
     @property
     def excludes(self):
+        # type: () -> EntityCollection[PermissionGrantConditionSet]
         """
         Condition sets which are excluded in this permission grant policy.
         This navigation is automatically expanded on GET.
@@ -32,6 +33,7 @@ class PermissionGrantPolicy(PolicyBase):
 
     @property
     def includes(self):
+        # type: () -> EntityCollection[PermissionGrantConditionSet]
         """
         Condition sets which are included in this permission grant policy.
         This navigation is automatically expanded on GET.

office365/directory/profile_photo.py

@@ -1,3 +1,5 @@
+from typing import Optional
+
 from office365.entity import Entity
 
 
@@ -12,14 +14,12 @@ class ProfilePhoto(Entity):
 
     @property
     def height(self):
-        """
-        The height of the photo. Read-only.
-        """
+        # type: () -> Optional[int]
+        """The height of the photo."""
         return self.properties.get("height", None)
 
     @property
     def width(self):
-        """
-        The width of the photo. Read-only.
-        """
+        # type: () -> Optional[int]
+        """The width of the photo."""
         return self.properties.get("width", None)

office365/directory/protection/riskyusers/risky_user.py

@@ -1,3 +1,5 @@
+from typing import Optional
+
 from office365.entity import Entity
 from office365.entity_collection import EntityCollection
 from office365.runtime.paths.resource_path import ResourcePath
@@ -27,8 +29,6 @@ class RiskyUser(Entity):
 
     @property
     def user_principal_name(self):
-        """
-        Risky user principal name.
-        :rtype: str or None
-        """
+        # type: () -> Optional[str]
+        """Risky user principal name."""
         return self.properties.get("userPrincipalName", None)

office365/directory/rolemanagement/resource_action.py

@@ -0,0 +1,10 @@
+from office365.runtime.client_value import ClientValue
+from office365.runtime.types.collections import StringCollection
+
+
+class ResourceAction(ClientValue):
+    """ """
+
+    def __init__(self):
+        self.allowedResourceActions = StringCollection()
+        self.notAllowedResourceActions = StringCollection()

office365/directory/rolemanagement/role_permission.py

@@ -0,0 +1,10 @@
+from office365.directory.rolemanagement.resource_action import ResourceAction
+from office365.runtime.client_value import ClientValue
+from office365.runtime.client_value_collection import ClientValueCollection
+
+
+class RolePermission(ClientValue):
+    """ """
+
+    def __init__(self, resourceActions=None):
+        self.resourceActions = ClientValueCollection(ResourceAction, resourceActions)

office365/directory/security/alerts/alert.py

@@ -1,3 +1,5 @@
+from typing import Optional
+
 from office365.directory.security.alerts.evidence import AlertEvidence
 from office365.directory.security.alerts.history_state import AlertHistoryState
 from office365.entity import Entity
@@ -11,17 +13,13 @@ class Alert(Entity):
 
     @property
     def actor_display_name(self):
-        """
-        The adversary or activity group that is associated with this alert.
-        :rtype: str
-        """
+        # type: () -> Optional[str]
+        """The adversary or activity group that is associated with this alert."""
         return self.properties.get("actorDisplayName", None)
 
     @property
     def alert_policy_id(self):
-        """
-        :rtype: str
-        """
+        # type: () -> Optional[str]
         return self.properties.get("alertPolicyId", None)
 
     @property

office365/directory/security/attacksimulations/landing_page.py

@@ -0,0 +1,5 @@
+from office365.entity import Entity
+
+
+class LandingPage(Entity):
+    """Represents an attack simulation landing page."""

office365/directory/security/attacksimulations/operation.py

@@ -0,0 +1,5 @@
+from office365.onedrive.operations.long_running import LongRunningOperation
+
+
+class AttackSimulationOperation(LongRunningOperation):
+    """Represents the status of a long-running attack simulation training operation."""

office365/directory/security/attacksimulations/report.py

@@ -1,7 +1,11 @@
 from office365.directory.security.attacksimulations.report_overview import (
     SimulationReportOverview,
 )
+from office365.directory.security.attacksimulations.users.details import (
+    UserSimulationDetails,
+)
 from office365.runtime.client_value import ClientValue
+from office365.runtime.client_value_collection import ClientValueCollection
 
 
 class SimulationReport(ClientValue):
@@ -10,8 +14,11 @@ class SimulationReport(ClientValue):
     participated in the campaign.
     """
 
-    def __init__(self, overview=SimulationReportOverview()):
+    def __init__(self, overview=SimulationReportOverview(), simulationUsers=None):
         """
         :param SimulationReportOverview overview: Overview of an attack simulation and training campaign.
         """
         self.overview = overview
+        self.simulationUsers = ClientValueCollection(
+            UserSimulationDetails, simulationUsers
+        )

office365/directory/security/attacksimulations/root.py

@@ -1,6 +1,10 @@
 from office365.directory.security.attacksimulations.automation import (
     SimulationAutomation,
 )
+from office365.directory.security.attacksimulations.landing_page import LandingPage
+from office365.directory.security.attacksimulations.operation import (
+    AttackSimulationOperation,
+)
 from office365.directory.security.attacksimulations.simulation import Simulation
 from office365.entity import Entity
 from office365.entity_collection import EntityCollection
@@ -11,8 +15,35 @@ class AttackSimulationRoot(Entity):
     """Represents an abstract type that provides the ability to launch a realistic phishing attack that organizations
     can learn from."""
 
+    @property
+    def landing_pages(self):
+        # type: () -> EntityCollection[LandingPage]
+        """Represents an attack simulation training landing page."""
+        return self.properties.get(
+            "landingPages",
+            EntityCollection(
+                self.context,
+                LandingPage,
+                ResourcePath("landingPages", self.resource_path),
+            ),
+        )
+
+    @property
+    def operations(self):
+        # type: () -> EntityCollection[AttackSimulationOperation]
+        """Represents an attack simulation training operation."""
+        return self.properties.get(
+            "operations",
+            EntityCollection(
+                self.context,
+                AttackSimulationOperation,
+                ResourcePath("operations", self.resource_path),
+            ),
+        )
+
     @property
     def simulations(self):
+        # type: () -> EntityCollection[Simulation]
         """Represents an attack simulation training campaign in a tenant."""
         return self.properties.get(
             "simulations",
@@ -25,6 +56,7 @@ class AttackSimulationRoot(Entity):
 
     @property
     def simulation_automations(self):
+        # type: () -> EntityCollection[SimulationAutomation]
         """Represents simulation automation created to run on a tenant."""
         return self.properties.get(
             "simulationAutomations",
@@ -38,6 +70,7 @@ class AttackSimulationRoot(Entity):
     def get_property(self, name, default_value=None):
         if default_value is None:
             property_mapping = {
+                "landingPages": self.landing_pages,
                 "simulationAutomations": self.simulation_automations,
             }
             default_value = property_mapping.get(name, None)

office365/directory/security/attacksimulations/users/details.py

@@ -0,0 +1,5 @@
+from office365.runtime.client_value import ClientValue
+
+
+class UserSimulationDetails(ClientValue):
+    """Represents a user of a tenant and their online actions in an attack simulation and training campaign."""

office365/directory/security/hunting_query_results.py

@@ -0,0 +1,5 @@
+from office365.runtime.client_value import ClientValue
+
+
+class HuntingQueryResults(ClientValue):
+    """The results of running a query for advanced hunting."""

office365/directory/security/incidents/incident.py

@@ -1,4 +1,5 @@
 from datetime import datetime
+from typing import Optional
 
 from office365.directory.security.alerts.alert import Alert
 from office365.directory.security.alerts.comment import AlertComment
@@ -23,37 +24,31 @@ class Incident(Entity):
 
     @property
     def assigned_to(self):
-        """
-        Owner of the incident, or null if no owner is assigned. Free editable text.
-        :rtype: str or None
-        """
+        # type: () -> Optional[str]
+        """Owner of the incident, or null if no owner is assigned. Free editable text."""
         return self.properties.get("assignedTo", None)
 
     @property
     def classification(self):
-        """
-        The specification for the incident.
+        # type: () -> Optional[str]
+        """The specification for the incident.
         Possible values are: unknown, falsePositive, truePositive, informationalExpectedActivity, unknownFutureValue.
-        :rtype: str or None
         """
         return self.properties.get("classification", None)
 
     @property
     def comments(self):
-        """
-        Array of comments created by the Security Operations (SecOps) team when the incident is managed.
-        """
+        """Array of comments created by the Security Operations (SecOps) team when the incident is managed."""
         return self.properties.get("comments", ClientValueCollection(AlertComment))
 
     @property
     def created_datetime(self):
-        """
-        Time when the incident was first created.
-        """
+        """Time when the incident was first created."""
         return self.properties("createdDateTime", datetime.min)
 
     @property
     def alerts(self):
+        # type: () -> EntityCollection[Alert]
         """The list of related alerts. Supports $expand."""
         return self.properties.get(
             "alerts",

office365/directory/security/security.py

@@ -1,6 +1,7 @@
 from office365.directory.security.alerts.alert import Alert
 from office365.directory.security.attacksimulations.root import AttackSimulationRoot
 from office365.directory.security.cases.root import CasesRoot
+from office365.directory.security.hunting_query_results import HuntingQueryResults
 from office365.directory.security.incidents.incident import Incident
 from office365.directory.security.threatintelligence.threat_intelligence import (
     ThreatIntelligence,
@@ -8,13 +9,30 @@ from office365.directory.security.threatintelligence.threat_intelligence import
 from office365.directory.security.triggers.root import TriggersRoot
 from office365.entity import Entity
 from office365.entity_collection import EntityCollection
+from office365.runtime.client_result import ClientResult
 from office365.runtime.paths.resource_path import ResourcePath
+from office365.runtime.queries.service_operation import ServiceOperationQuery
 
 
 class Security(Entity):
     """The security resource is the entry point for the Security object model. It returns a singleton security resource.
     It doesn't contain any usable properties."""
 
+    def run_hunting_query(self, query):
+        """
+        Queries a specified set of event, activity, or entity data supported by Microsoft 365 Defender
+        to proactively look for specific threats in your environment.
+        :param str query: The hunting query in Kusto Query Language (KQL). For more information on KQL syntax,see KQL
+            quick reference: https://learn.microsoft.com/en-us/azure/data-explorer/kusto/query/kql-quick-reference
+        """
+        return_type = ClientResult(self.context, HuntingQueryResults())
+        payload = {"Query": query}
+        qry = ServiceOperationQuery(
+            self, "runHuntingQuery", None, payload, None, return_type
+        )
+        self.context.add_query(qry)
+        return return_type
+
     @property
     def alerts(self):
         # type: () -> EntityCollection[Alert]
@@ -28,9 +46,7 @@ class Security(Entity):
     @property
     def alerts_v2(self):
         # type: () -> EntityCollection[Alert]
-        """
-        A collection of alerts in Microsoft 365 Defender.
-        """
+        """A collection of alerts in Microsoft 365 Defender."""
         return self.properties.get(
             "alerts_v2",
             EntityCollection(
@@ -69,6 +85,7 @@ class Security(Entity):
 
     @property
     def triggers(self):
+        """"""
         return self.properties.get(
             "triggers",
             TriggersRoot(self.context, ResourcePath("triggers", self.resource_path)),

office365/directory/serviceprincipals/service_principal.py

@@ -104,7 +104,7 @@ class ServicePrincipal(DirectoryObject):
     def grant(self, app, app_role):
         # type: (Application|str, AppRole|str) -> Self
         """
-        Revokes an app role assignment to a client service principal
+        Grants an app role assignment to a client service principal
         :param Application or str app: Application object or app identifier
         :param AppRole or str app_role: AppRole object or name
         """
@@ -205,9 +205,7 @@ class ServicePrincipal(DirectoryObject):
 
     @property
     def app_roles(self):
-        """
-        The roles exposed by the application which this service principal represents.
-        """
+        """The roles exposed by the application which this service principal represents."""
         return self.properties.get("appRoles", AppRoleCollection())
 
     @property
@@ -299,6 +297,7 @@ class ServicePrincipal(DirectoryObject):
 
     @property
     def oauth2_permission_scopes(self):
+        # type: () -> ClientValueCollection[PermissionScope]
         """
         The delegated permissions exposed by the application. For more information see the oauth2PermissionScopes
         property on the application entity's api property.

office365/directory/synchronization/synchronization.py

@@ -16,6 +16,7 @@ class Synchronization(Entity):
 
     @property
     def jobs(self):
+        # type: () -> EntityCollection[SynchronizationJob]
         """
         Performs synchronization by periodically running in the background, polling for changes in one directory,
         and pushing them to another directory.
@@ -31,6 +32,7 @@ class Synchronization(Entity):
 
     @property
     def templates(self):
+        # type: () -> EntityCollection[SynchronizationTemplate]
         """
         Performs synchronization by periodically running in the background, polling for changes in one directory,
         and pushing them to another directory.

office365/directory/users/activities/history_item.py

@@ -1,4 +1,5 @@
 import datetime
+from typing import Optional
 
 from office365.directory.users.activities.activity import UserActivity
 from office365.entity import Entity
@@ -16,10 +17,10 @@ class ActivityHistoryItem(Entity):
 
     @property
     def active_duration_seconds(self):
+        # type: () -> Optional[int]
         """
-        Optional. The duration of active user engagement. if not supplied, this is calculated from the startedDateTime
+        The duration of active user engagement. if not supplied, this is calculated from the startedDateTime
         and lastActiveDateTime.
-        :rtype: int or None
         """
         return self.properties.get("activeDurationSeconds", None)
 

office365/directory/users/user.py

@@ -1,4 +1,5 @@
 import json
+from datetime import datetime
 from typing import Optional
 
 from office365.communications.onlinemeetings.collection import OnlineMeetingCollection
@@ -445,9 +446,29 @@ class User(DirectoryObject):
         self.context.add_query(qry)
         return return_type
 
+    @property
+    def created_datetime(self):
+        # type: () -> Optional[datetime]
+        """
+        The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time.
+        For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z
+        """
+        return self.properties.get("createdDateTime", datetime.min)
+
+    @property
+    def created_objects(self):
+        """Directory objects created by this user."""
+        return self.properties.get(
+            "createdObjects",
+            DirectoryObjectCollection(
+                self.context, ResourcePath("createdObjects", self.resource_path)
+            ),
+        )
+
     @property
     def device_enrollment_limit(self):
         # type: () -> Optional[str]
+        """ """
         return self.properties.get("deviceEnrollmentLimit", None)
 
     @property
@@ -630,6 +651,16 @@ class User(DirectoryObject):
             ProfilePhoto(self.context, ResourcePath("photo", self.resource_path)),
         )
 
+    @property
+    def photos(self):
+        """The collection of the user's profile photos in different sizes"""
+        return self.properties.get(
+            "photos",
+            EntityCollection(
+                self.context, ProfilePhoto, ResourcePath("photos", self.resource_path)
+            ),
+        )
+
     @property
     def manager(self):
         """The user or contact that is this user's manager"""
@@ -770,7 +801,7 @@ class User(DirectoryObject):
     @property
     def managed_devices(self):
         # type: () -> EntityCollection[ManagedDevice]
-        """"""
+        """Devices that are managed or pre-enrolled through Intune"""
         return self.properties.get(
             "managedDevices",
             EntityCollection(
@@ -936,9 +967,7 @@ class User(DirectoryObject):
 
     @property
     def online_meetings(self):
-        """
-        Get a user's online meetings.
-        """
+        """Get a user's online meetings."""
         return self.properties.get(
             "onlineMeetings",
             OnlineMeetingCollection(
@@ -987,21 +1016,18 @@ class User(DirectoryObject):
     @property
     def street_address(self):
         # type: () -> Optional[str]
-        """
-        The street address of the user's place of business. Maximum length is 1024 characters.
-        """
+        """The street address of the user's place of business. Maximum length is 1024 characters."""
         return self.properties.get("streetAddress", None)
 
     @property
     def security_identifier(self):
         # type: () -> Optional[str]
-        """
-        Security identifier (SID) of the user, used in Windows scenarios.
-        """
+        """Security identifier (SID) of the user, used in Windows scenarios."""
         return self.properties.get("securityIdentifier", None)
 
     @property
     def teamwork(self):
+        # type: () -> UserTeamwork
         """A container for the range of Microsoft Teams functionalities that are available per user in the tenant."""
         return self.properties.get(
             "teamwork",
@@ -1042,6 +1068,7 @@ class User(DirectoryObject):
                 "businessPhones": self.business_phones,
                 "calendarGroups": self.calendar_groups,
                 "contactFolders": self.contact_folders,
+                "createdObjects": self.created_objects,
                 "employeeExperience": self.employee_experience,
                 "followedSites": self.followed_sites,
                 "licenseDetails": self.license_details,

office365/entity_collection.py

@@ -3,7 +3,6 @@ from typing import TYPE_CHECKING, Any, Optional, Type, TypeVar
 from office365.entity import Entity
 from office365.runtime.client_object_collection import ClientObjectCollection
 from office365.runtime.compat import is_string_type
-from office365.runtime.paths.item import ItemPath
 from office365.runtime.paths.resource_path import ResourcePath
 from office365.runtime.paths.v4.entity import EntityPath
 from office365.runtime.queries.create_entity import CreateEntityQuery
@@ -43,7 +42,9 @@ class EntityCollection(ClientObjectCollection[T]):
     def add(self, **kwargs):
         # type: (Any) -> T
         """Creates an entity and prepares the query"""
-        return_type = self.create_typed_object(kwargs, ItemPath(self.resource_path))
+        return_type = self.create_typed_object(
+            kwargs, EntityPath(None, self.resource_path)
+        )
         self.add_child(return_type)
         qry = CreateEntityQuery(self, return_type, return_type)
         self.context.add_query(qry)