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

office365/directory/object_collection.py

@@ -1,7 +1,8 @@
+from typing_extensions import Self
+
 from office365.delta_collection import DeltaCollection
 from office365.directory.object import DirectoryObject
 from office365.entity_collection import EntityCollection
-from office365.runtime.client_result import ClientResult
 from office365.runtime.http.http_method import HttpMethod
 from office365.runtime.http.request_options import RequestOptions
 from office365.runtime.queries.service_operation import ServiceOperationQuery
@@ -15,29 +16,32 @@ class DirectoryObjectCollection(DeltaCollection[DirectoryObject]):
             context, DirectoryObject, resource_path
         )
 
-    def get_by_ids(self, ids):
+    def get_by_ids(self, ids, types=None):
         """
         Returns the directory objects specified in a list of IDs.
-
-        :type ids: list[str]
+        :param list[str] ids: A collection of IDs for which to return objects. The IDs are GUIDs, represented as
+            strings. You can specify up to 1000 IDs.
+        :param list[str] types: A collection of resource types that specifies the set of resource collections to search.
+            If not specified, the default is directoryObject, which contains all of the resource types defined in
+            the directory. Any object that derives from directoryObject may be specified in the collection;
+            for example: user, group, and device objects.
         """
-        return_type = ClientResult(self.context)
-        params = {"ids": ids}
+        return_type = DirectoryObjectCollection(self.context)
+        params = {"ids": ids, "types": types}
         qry = ServiceOperationQuery(self, "getByIds", params, None, None, return_type)
         self.context.add_query(qry)
         return return_type
 
-    def add(self, user_id):
-        """
-        Add a user to the group.
+    def add(self, directory_object):
+        # type: (DirectoryObject) -> Self
+        """Adds directory objects to the collection."""
 
-        :type user_id: str
-        """
-        payload = {
-            "@odata.id": "https://graph.microsoft.com/v1.0/users/{0}".format(user_id)
-        }
-        qry = ServiceOperationQuery(self, "$ref", None, payload)
-        self.context.add_query(qry)
+        def _add():
+            payload = {"@odata.id": directory_object.resource_url}
+            qry = ServiceOperationQuery(self, "$ref", None, payload)
+            self.context.add_query(qry)
+
+        directory_object.ensure_property("id", _add)
         return self
 
     def get_available_extension_properties(self, is_synced_from_on_premises=None):
@@ -60,19 +64,30 @@ class DirectoryObjectCollection(DeltaCollection[DirectoryObject]):
         self.context.add_query(qry)
         return return_type
 
-    def remove(self, user_id):
-        """Remove a user from the group.
-
-        :param str user_id: User identifier
+    def remove(self, directory_object):
+        # type: (DirectoryObject|str) -> Self
+        """Removes directory object from the collection.
+        :param str directory_object: Directory object or identifier
         """
 
-        qry = ServiceOperationQuery(self, "{0}/$ref".format(user_id))
+        def _remove(id_):
+            qry = ServiceOperationQuery(self, "{0}/$ref".format(id_))
+
+            def _construct_request(request):
+                # type: (RequestOptions) -> None
+                request.method = HttpMethod.Delete
+
+            self.context.add_query(qry).before_query_execute(_construct_request)
+
+        if isinstance(directory_object, DirectoryObject):
+
+            def _loaded():
+                _remove(directory_object.id)
 
-        def _construct_request(request):
-            # type: (RequestOptions) -> None
-            request.method = HttpMethod.Delete
+            directory_object.ensure_property("id", _loaded)
+        else:
+            _remove(directory_object)
 
-        self.context.add_query(qry).before_query_execute(_construct_request)
         return self
 
     def validate_properties(

office365/directory/password_credential.py

@@ -31,3 +31,6 @@ class PasswordCredential(ClientValue):
         self.keyId = key_id
         self.startDateTime = start_datetime
         self.endDateTime = end_datetime
+
+    def __str__(self):
+        return self.displayName or self.entity_type_name

office365/directory/permissions/default_user_role.py

@@ -0,0 +1,5 @@
+from office365.runtime.client_value import ClientValue
+
+
+class DefaultUserRolePermissions(ClientValue):
+    """Contains certain customizable permissions of default user role in Microsoft Entra ID."""

office365/directory/permissions/grants/condition_set.py

@@ -1,3 +1,5 @@
+from typing import Optional
+
 from office365.entity import Entity
 from office365.runtime.types.collections import StringCollection
 
@@ -29,10 +31,10 @@ class PermissionGrantConditionSet(Entity):
 
     @property
     def client_applications_from_verified_publisher_only(self):
+        # type: () -> Optional[bool]
         """
         Set to true to only match on client applications with a verified publisher. Set to false to match on any client
         app, even if it does not have a verified publisher. Default is false.
-        :rtype: bool
         """
         return self.properties.get("clientApplicationsFromVerifiedPublisherOnly", None)
 
@@ -50,9 +52,9 @@ class PermissionGrantConditionSet(Entity):
 
     @property
     def resource_application(self):
+        # type: () -> Optional[str]
         """
         The appId of the resource application (e.g. the API) for which a permission is being granted, or any to match
         with any resource application or API. Default is any.
-        :rtype: str
         """
         return self.properties.get("resourceApplication", None)

office365/directory/permissions/grants/oauth2.py

@@ -1,3 +1,5 @@
+from typing import Optional
+
 from office365.entity import Entity
 
 
@@ -13,56 +15,51 @@ class OAuth2PermissionGrant(Entity):
 
     @property
     def client_id(self):
+        # type: () -> Optional[str]
         """
         The id of the client service principal for the application which is authorized to act on behalf of a signed-in
         user when accessing an API. Required. Supports $filter (eq only).
-
-        :rtype: str
         """
         return self.properties.get("clientId", None)
 
     @property
     def consent_type(self):
+        # type: () -> Optional[str]
         """
         Indicates if authorization is granted for the client application to impersonate all users or only a
         specific user. AllPrincipals indicates authorization to impersonate all users.
         Principal indicates authorization to impersonate a specific user. Consent on behalf of all users can be granted
         by an administrator. Non-admin users may be authorized to consent on behalf of themselves in some cases,
         for some delegated permissions. Required. Supports $filter (eq only).
-
-        :rtype: str
         """
         return self.properties.get("consentType", None)
 
     @property
     def principal_id(self):
+        # type: () -> Optional[str]
         """
         The id of the user on behalf of whom the client is authorized to access the resource, when consentType is
         Principal. If consentType is AllPrincipals this value is null. Required when consentType is Principal.
         Supports $filter (eq only).
-
-        :rtype: str
         """
         return self.properties.get("principalId", None)
 
     @property
     def resource_id(self):
+        # type: () -> Optional[str]
         """
         The id of the resource service principal to which access is authorized. This identifies the API which the
         client is authorized to attempt to call on behalf of a signed-in user. Supports $filter (eq only).
-
-        :rtype: str
         """
         return self.properties.get("resourceId", None)
 
     @property
     def scope(self):
+        # type: () -> Optional[str]
         """
         A space-separated list of the claim values for delegated permissions which should be included in access tokens
         for the resource application (the API). For example, openid User.Read GroupMember.Read.All. Each claim value
         should match the value field of one of the delegated permissions defined by the API, listed in the
         oauth2PermissionScopes property of the resource service principal. Must not exceed 3850 characters in length.
-
-        :rtype: str
         """
         return self.properties.get("scope", None)

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/device_registration.py

@@ -0,0 +1,6 @@
+from office365.entity import Entity
+
+
+class DeviceRegistrationPolicy(Entity):
+    """Represents the policy scope that controls quota restrictions, additional authentication, and authorization
+    policies to register device identities to your organization."""

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/policies/root.py

@@ -9,6 +9,7 @@ from office365.directory.policies.authentication_strength import (
 from office365.directory.policies.authorization import AuthorizationPolicy
 from office365.directory.policies.conditional_access import ConditionalAccessPolicy
 from office365.directory.policies.cross_tenant_access import CrossTenantAccessPolicy
+from office365.directory.policies.device_registration import DeviceRegistrationPolicy
 from office365.directory.policies.permission_grant import PermissionGrantPolicy
 from office365.directory.policies.tenant_app_management import TenantAppManagementPolicy
 from office365.entity import Entity
@@ -33,6 +34,17 @@ class PolicyRoot(Entity):
             ),
         )
 
+    @property
+    def device_registration_policy(self):
+        """ """
+        return self.properties.get(
+            "deviceRegistrationPolicy",
+            DeviceRegistrationPolicy(
+                self.context,
+                ResourcePath("deviceRegistrationPolicy", self.resource_path),
+            ),
+        )
+
     def authentication_strength_policies(self):
         # type: () -> EntityCollection[AuthenticationStrengthPolicy]
         """
@@ -147,6 +159,7 @@ class PolicyRoot(Entity):
                 "conditional_access_policies": self.conditional_access_policies,
                 "crossTenantAccessPolicy": self.cross_tenant_access_policy,
                 "defaultAppManagementPolicy": self.default_app_management_policy,
+                "deviceRegistrationPolicy": self.device_registration_policy,
                 "permissionGrantPolicies": self.permission_grant_policies,
             }
             default_value = property_mapping.get(name, None)

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/security/threatintelligence/article_indicator.py

@@ -0,0 +1,7 @@
+from office365.entity import Entity
+
+
+class ArticleIndicator(Entity):
+    """
+    Represents a resource that communicates indicators of threat or compromise related to the contents of an article
+    """