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

office365/directory/serviceprincipals/service_principal.py

@@ -104,17 +104,15 @@ 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
         """
 
         def _grant(principal):
             # type: ("ServicePrincipal") -> None
-            app_role_id = repr(app_role)
-            principal_id = principal.id
             self.app_role_assigned_to.add(
-                principalId=principal_id, resourceId=self.id, appRoleId=app_role_id
+                principalId=principal.id, resourceId=self.id, appRoleId=app_role.id
             )
 
         def _ensure_principal():
@@ -128,20 +126,17 @@ class ServicePrincipal(DirectoryObject):
         """Revokes an app role assignment from a client service principal"""
 
         def _revoke(principal):
-            # type ("ServicePrincipal") -> None
-            principal_id = principal.id
-            app_role_id = repr(app_role)
+            # type: ("ServicePrincipal") -> None
             app_role_assigned_to_ids = [
                 item.id
                 for item in self.app_role_assigned_to
-                if item.principal_id == principal_id and item.app_role_id == app_role_id
+                if item.principal_id == principal.id and item.app_role_id == app_role.id
             ]
             if len(app_role_assigned_to_ids) > 0:
                 self.app_role_assigned_to[app_role_assigned_to_ids[0]].delete_object()
 
         def _ensure_resource(principal):
             self.ensure_properties(["id", "appRoleAssignedTo"], _revoke, principal)
-            # self.app_role_assigned_to.get_all(page_loaded=_revoke)
 
         def _ensure_principal():
             self.context.service_principals.get_by_app(app).get().after_execute(
@@ -205,9 +200,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 +292,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/schema.py

@@ -1,4 +1,7 @@
+from office365.directory.synchronization.directory_definition import DirectoryDefinition
 from office365.entity import Entity
+from office365.entity_collection import EntityCollection
+from office365.runtime.paths.resource_path import ResourcePath
 
 
 class SynchronizationSchema(Entity):
@@ -9,3 +12,16 @@ class SynchronizationSchema(Entity):
 
     The following sections describe the high-level components of the synchronization schema.
     """
+
+    @property
+    def directories(self):
+        # type: () -> EntityCollection[DirectoryDefinition]
+        """Contains the collection of directories and all of their objects."""
+        return self.properties.get(
+            "directories",
+            EntityCollection(
+                self.context,
+                DirectoryDefinition,
+                ResourcePath("directories", self.resource_path),
+            ),
+        )

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
@@ -49,6 +50,7 @@ from office365.outlook.mail.mailbox_settings import MailboxSettings
 from office365.outlook.mail.messages.collection import MessageCollection
 from office365.outlook.mail.messages.message import Message
 from office365.outlook.mail.recipient import Recipient
+from office365.outlook.mail.tips import MailTips
 from office365.outlook.user import OutlookUser
 from office365.planner.user import PlannerUser
 from office365.runtime.client_result import ClientResult
@@ -168,6 +170,28 @@ class User(DirectoryObject):
         self.context.add_query(qry)
         return self
 
+    def get_mail_tips(self, email_addresses, mail_tips_options=None):
+        """Get the MailTips of one or more recipients as available to the signed-in user.
+        :param list[str] email_addresses: A collection of SMTP addresses of recipients to get MailTips for.
+        :param str mail_tips_options: A enumeration of flags that represents the requested mailtips.
+            Possible values are: automaticReplies, customMailTip, deliveryRestriction, externalMemberCount,
+            mailboxFullStatus, maxMessageSize, moderationStatus, recipientScope, recipientSuggestions,
+            and totalMemberCount.
+        """
+        return_type = ClientResult(self.context, ClientValueCollection(MailTips))
+        payload = {
+            "EmailAddresses": StringCollection(email_addresses),
+            "MailTipsOptions": mail_tips_options,
+        }
+        qry = ServiceOperationQuery(
+            self,
+            "getMailTips",
+            None,
+            payload,
+        )
+        self.context.add_query(qry)
+        return return_type
+
     def send_mail(
         self,
         subject,
@@ -445,9 +469,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 +674,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 +824,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 +990,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 +1039,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 +1091,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)

office365/graph_client.py

@@ -6,6 +6,12 @@ from office365.delta_collection import DeltaCollection
 from office365.directory.applications.collection import ApplicationCollection
 from office365.directory.applications.template import ApplicationTemplate
 from office365.directory.audit.log_root import AuditLogRoot
+from office365.directory.authentication.method_configuration import (
+    AuthenticationMethodConfiguration,
+)
+from office365.directory.certificates.auth_configuration import (
+    CertificateBasedAuthConfiguration,
+)
 from office365.directory.directory import Directory
 from office365.directory.domains.domain import Domain
 from office365.directory.extensions.schema import SchemaExtension
@@ -35,6 +41,7 @@ from office365.directory.users.user import User
 from office365.education.root import EducationRoot
 from office365.entity_collection import EntityCollection
 from office365.intune.devices.app_management import DeviceAppManagement
+from office365.intune.devices.collection import DeviceCollection
 from office365.intune.devices.management.management import DeviceManagement
 from office365.intune.organizations.contact import OrgContact
 from office365.intune.organizations.organization import Organization
@@ -65,19 +72,31 @@ from office365.teams.collection import TeamCollection
 from office365.teams.template import TeamsTemplate
 from office365.teams.viva.employee_experience import EmployeeExperience
 
+environments_endpoints = {
+    "GCCH": {
+        "graph_url": "https://graph.microsoft.com",
+        "entra_url": "https://login.microsoftonline.com",
+    },
+    "GCC High": {
+        "graph_url": "https://graph.microsoft.us",
+        "entra_url": "https://login.microsoftonline.us",
+    },
+    "DoD": {
+        "graph_url": "https://dod-graph.microsoft.us",
+        "entra_url": "https://login.chinacloudapi.cn",
+    },
+}
+
 
 class GraphClient(ClientRuntimeContext):
     """Graph Service client"""
 
-    def __init__(self, acquire_token_callback):
-        # type: (Callable[[], dict]) -> None
-        """
-        :param () -> dict acquire_token_callback: Acquire token function
-        """
+    def __init__(self, acquire_token_callback, version="v1.0", environment="GCCH"):
+        # type: (Callable[[], dict], str, str) -> None
         super(GraphClient, self).__init__()
         self._pending_request = None
-        self._resource = "https://graph.microsoft.com"
-        self._authority_host_url = "https://login.microsoftonline.com"
+        self._version = version
+        self._environment_endpoints = environments_endpoints.get(environment, None)
         self._acquire_token_callback = acquire_token_callback
 
     @staticmethod
@@ -130,7 +149,7 @@ class GraphClient(ClientRuntimeContext):
         :param str client_secret: Client secret
         :param list[str] or None scopes: Scopes requested to access an API
         :param Any token_cache: Default cache is in memory only,
-        Refer https://msal-python.readthedocs.io/en/latest/#msal.SerializableTokenCache
+             Refer https://msal-python.readthedocs.io/en/latest/#msal.SerializableTokenCache
         """
         if scopes is None:
             scopes = ["https://graph.microsoft.com/.default"]
@@ -248,7 +267,7 @@ class GraphClient(ClientRuntimeContext):
 
     def service_root_url(self):
         # type: () -> str
-        return "https://graph.microsoft.com/v1.0"
+        return "https://graph.microsoft.com/{0}".format(self._version)
 
     def _build_specific_query(self, request):
         # type: (RequestOptions) -> None
@@ -334,6 +353,11 @@ class GraphClient(ClientRuntimeContext):
         """Directory Objects container"""
         return DirectoryObjectCollection(self, ResourcePath("directoryObjects"))
 
+    @property
+    def devices(self):
+        """Devices container"""
+        return DeviceCollection(self, ResourcePath("devices"))
+
     @property
     def teams(self):
         """Teams container"""
@@ -393,11 +417,29 @@ class GraphClient(ClientRuntimeContext):
             self, ApplicationTemplate, ResourcePath("applicationTemplates")
         )
 
+    @property
+    def authentication_method_configurations(self):
+        """Get the list of application templates in this organization."""
+        return EntityCollection(
+            self,
+            AuthenticationMethodConfiguration,
+            ResourcePath("authenticationMethodConfigurations"),
+        )
+
     @property
     def applications(self):
         """Get the list of applications in this organization."""
         return ApplicationCollection(self, ResourcePath("applications"))
 
+    @property
+    def certificate_based_auth_configuration(self):
+        """Get the list of applications in this organization."""
+        return EntityCollection(
+            self,
+            CertificateBasedAuthConfiguration,
+            ResourcePath("certificateBasedAuthConfiguration"),
+        )
+
     @property
     def service_principals(self):
         """Retrieve a list of servicePrincipal objects."""
@@ -429,16 +471,12 @@ class GraphClient(ClientRuntimeContext):
 
     @property
     def communications(self):
-        """
-        Cloud communications API endpoint
-        """
+        """Cloud communications API endpoint"""
         return CloudCommunications(self, ResourcePath("communications"))
 
     @property
     def identity_governance(self):
-        """
-        The identity governance singleton
-        """
+        """The identity governance singleton"""
         return IdentityGovernance(self, ResourcePath("identityGovernance"))
 
     @property
@@ -503,9 +541,7 @@ class GraphClient(ClientRuntimeContext):
 
     @property
     def teams_templates(self):
-        """
-        Get the list of teams templates.
-        """
+        """Get the list of teams templates."""
         return EntityCollection(self, TeamsTemplate, ResourcePath("teamsTemplates"))
 
     @property
@@ -518,34 +554,26 @@ class GraphClient(ClientRuntimeContext):
 
     @property
     def permission_grants(self):
-        """
-        List all resource-specific permission grants
-        """
+        """List all resource-specific permission grants"""
         return EntityCollection(
             self, ResourceSpecificPermissionGrant, ResourcePath("permissionGrants")
         )
 
     @property
     def print(self):
-        """
-        Used to manage printers and print jobs within Universal Print.
-        """
+        """Used to manage printers and print jobs within Universal Print."""
         from office365.intune.printing.print import Print
 
         return Print(self, ResourcePath("print"))
 
     @property
     def search(self):
-        """
-        The search endpoint is the entry point for Microsoft Search API to query data.
-        """
+        """The search endpoint is the entry point for Microsoft Search API to query data."""
         return SearchEntity(self, ResourcePath("search"))
 
     @property
     def employee_experience(self):
-        """
-        An alias to EmployeeExperience
-        """
+        """An alias to EmployeeExperience"""
         return EmployeeExperience(self, ResourcePath("employeeExperience"))
 
     @property

office365/intune/audit/event.py

@@ -17,9 +17,7 @@ class AuditEvent(Entity):
 
     @property
     def actor(self):
-        """
-        AAD user and application that are associated with the audit event.
-        """
+        """AAD user and application that are associated with the audit event."""
         return self.properties.get("actor", AuditActor())
 
     @property

office365/intune/audit/event_collection.py

@@ -5,7 +5,7 @@ from office365.runtime.queries.function import FunctionQuery
 from office365.runtime.types.collections import StringCollection
 
 
-class AuditEventCollection(EntityCollection):
+class AuditEventCollection(EntityCollection[AuditEvent]):
     def __init__(self, context, resource_path=None):
         super(AuditEventCollection, self).__init__(context, AuditEvent, resource_path)
 

office365/intune/devices/alternative_security_id.py

@@ -3,3 +3,7 @@ from office365.runtime.client_value import ClientValue
 
 class AlternativeSecurityId(ClientValue):
     """"""
+
+    def __init__(self, type_=None, key=None):
+        self.type = type_
+        self.key = key

office365/intune/devices/collection.py

@@ -0,0 +1,57 @@
+import random
+import string
+import uuid
+
+from office365.delta_collection import DeltaCollection
+from office365.intune.devices.alternative_security_id import AlternativeSecurityId
+from office365.intune.devices.device import Device
+from office365.runtime.client_value_collection import ClientValueCollection
+from office365.runtime.queries.create_entity import CreateEntityQuery
+
+
+class DeviceCollection(DeltaCollection[Device]):
+    """Device's collection"""
+
+    def __init__(self, context, resource_path=None):
+        super(DeviceCollection, self).__init__(context, Device, resource_path)
+
+    def add(
+        self,
+        display_name,
+        operating_system,
+        operating_system_version,
+        account_enabled=False,
+        alternative_security_id=None,
+        device_id=None,
+    ):
+        """Create and register a new device in the organization.
+        :param str display_name: The display name for the device
+        :param str operating_system:
+        :param str operating_system_version:
+        :param bool account_enabled:
+        :param AlternativeSecurityId alternative_security_id:
+        :param str device_id:
+        """
+
+        if alternative_security_id is None:
+            key_id = "base64" + "".join(
+                random.choice(string.ascii_lowercase + string.digits) for _ in range(10)
+            )
+            alternative_security_id = AlternativeSecurityId(2, key_id)
+        if device_id is None:
+            device_id = str(uuid.uuid4())
+
+        return_type = Device(self.context)
+        return_type.set_property("displayName", display_name)
+        return_type.set_property("operatingSystem", operating_system)
+        return_type.set_property("operatingSystemVersion", operating_system_version)
+        return_type.set_property("accountEnabled", account_enabled)
+        return_type.set_property("deviceId", device_id)
+        return_type.set_property(
+            "alternativeSecurityIds",
+            ClientValueCollection(AlternativeSecurityId, [alternative_security_id]),
+        )
+        self.add_child(return_type)
+        qry = CreateEntityQuery(self, return_type, return_type)
+        self.context.add_query(qry)
+        return return_type

office365/intune/devices/device.py

@@ -1,5 +1,9 @@
+from typing import Optional
+
 from office365.directory.object import DirectoryObject
 from office365.directory.object_collection import DirectoryObjectCollection
+from office365.intune.devices.alternative_security_id import AlternativeSecurityId
+from office365.runtime.client_value_collection import ClientValueCollection
 from office365.runtime.paths.resource_path import ResourcePath
 
 
@@ -10,16 +14,28 @@ class Device(DirectoryObject):
     authentication. These devices can range from desktop and laptop machines to phones and tablets.
     """
 
-    def get_property(self, name, default_value=None):
-        if default_value is None:
-            property_mapping = {
-                "memberOf": self.member_of,
-                "registeredOwners": self.registered_owners,
-                "registeredUsers": self.registered_users,
-                "transitiveMemberOf": self.transitive_member_of,
-            }
-            default_value = property_mapping.get(name, None)
-        return super(Device, self).get_property(name, default_value)
+    def __repr__(self):
+        return self.device_id or self.entity_type_name
+
+    @property
+    def alternative_security_ids(self):
+        """For internal use only."""
+        return self.properties.get(
+            "alternativeSecurityIds", ClientValueCollection(AlternativeSecurityId)
+        )
+
+    @property
+    def device_id(self):
+        # type: () -> Optional[str]
+        """Unique identifier set by Azure Device Registration Service at the time of registration.
+        This is an alternate key that can be used to reference the device object."""
+        return self.properties.get("deviceId", None)
+
+    @property
+    def device_ownership(self):
+        # type: () -> Optional[str]
+        """Ownership of the device. This property is set by Intune. Possible values are: unknown, company, personal."""
+        return self.properties.get("deviceOwnership", None)
 
     @property
     def member_of(self):
@@ -65,3 +81,15 @@ class Device(DirectoryObject):
                 self.context, ResourcePath("transitiveMemberOf", self.resource_path)
             ),
         )
+
+    def get_property(self, name, default_value=None):
+        if default_value is None:
+            property_mapping = {
+                "alternativeSecurityIds": self.alternative_security_ids,
+                "memberOf": self.member_of,
+                "registeredOwners": self.registered_owners,
+                "registeredUsers": self.registered_users,
+                "transitiveMemberOf": self.transitive_member_of,
+            }
+            default_value = property_mapping.get(name, None)
+        return super(Device, self).get_property(name, default_value)

office365/intune/devices/management/management.py

@@ -1,3 +1,4 @@
+from office365.directory.rolemanagement.role_permission import RolePermission
 from office365.entity import Entity
 from office365.entity_collection import EntityCollection
 from office365.intune.audit.event_collection import AuditEventCollection
@@ -8,7 +9,10 @@ from office365.intune.devices.enrollment.configuration import (
 )
 from office365.intune.devices.managed import ManagedDevice
 from office365.intune.devices.management.reports.reports import DeviceManagementReports
+from office365.runtime.client_result import ClientResult
+from office365.runtime.client_value_collection import ClientValueCollection
 from office365.runtime.paths.resource_path import ResourcePath
+from office365.runtime.queries.function import FunctionQuery
 
 
 class DeviceManagement(Entity):
@@ -18,6 +22,14 @@ class DeviceManagement(Entity):
     configuration.
     """
 
+    def get_effective_permissions(self, scope=None):
+        """Retrieves the effective permissions of the currently authenticated user"""
+        return_type = ClientResult(self.context, ClientValueCollection(RolePermission))
+        # params = {"scope": scope}
+        qry = FunctionQuery(self, "getEffectivePermissions", None, return_type)
+        self.context.add_query(qry)
+        return return_type
+
     @property
     def audit_events(self):
         """"""

office365/intune/organizations/organization.py

@@ -43,6 +43,7 @@ class Organization(DirectoryObject):
 
     @property
     def extensions(self):
+        # type: () -> EntityCollection[Extension]
         """The collection of open extensions defined for the message. Nullable."""
         return self.properties.get(
             "extensions",