Directory namespace improvements (new types & methods)

Author: [email protected]

examples/b2c/registerIdP.py

@@ -3,6 +3,6 @@
 
 
 client = GraphClient(acquire_token_client_credentials)
-idp_col = client.identityProviders.get().execute_query()
+idp_col = client.identity_providers.get().execute_query()
 for idp in idp_col:
     print(idp.id)

examples/directory/delete_groups.py

@@ -13,7 +13,7 @@
     print("Group deleted.")
     index += 1
 
-deleted_groups = client.directory.deletedGroups.get().execute_query()
+deleted_groups = client.directory.deleted_groups.get().execute_query()
 groups_count = len(deleted_groups)
 index = 0
 while len(deleted_groups) > 0:

office365/directory/appRoleAssignment.py

@@ -0,0 +1,12 @@
+from office365.directory.directoryObject import DirectoryObject
+from office365.entity_collection import EntityCollection
+
+
+class AppRoleAssignment(DirectoryObject):
+    pass
+
+
+class AppRoleAssignmentCollection(EntityCollection):
+
+    def __init__(self, context, resource_path=None):
+        super(AppRoleAssignmentCollection, self).__init__(context, AppRoleAssignment, resource_path)

office365/directory/application.py

@@ -1,6 +1,8 @@
 from office365.directory.directoryObject import DirectoryObject
 from office365.directory.keyCredential import KeyCredential
+from office365.directory.passwordCredential import PasswordCredential
 from office365.runtime.client_value_collection import ClientValueCollection
+from office365.runtime.queries.service_operation_query import ServiceOperationQuery
 
 
 class Application(DirectoryObject):
@@ -12,6 +14,33 @@ class Application(DirectoryObject):
     an Application in Azure AD
     """
 
+    def add_password(self, display_name):
+        """Adds a strong password to an application.
+        :param str display_name: App display name
+        """
+        return_type = PasswordCredential(displayName=display_name)
+        qry = ServiceOperationQuery(self, "addPassword", None, return_type, None, return_type)
+        self.context.add_query(qry)
+        return return_type
+
+    def remove_password(self, keyId):
+        """Remove a password from an application."""
+        qry = ServiceOperationQuery(self, "removePassword", None, {"keyId": keyId})
+        self.context.add_query(qry)
+        return self
+
+    def delete_object(self, permanent_delete=False):
+        """
+        :param permanent_delete: Permanently deletes the application from directory
+        :type permanent_delete: bool
+
+        """
+        super(Application, self).delete_object()
+        if permanent_delete:
+            deleted_item = self.context.directory.deleted_applications[self.id]
+            deleted_item.delete_object()
+        return self
+
     @property
     def key_credentials(self):
         """The collection of key credentials associated with the application. Not nullable.

office365/directory/applicationCollection.py

@@ -6,3 +6,10 @@ class ApplicationCollection(EntityCollection):
 
     def __init__(self, context, resource_path=None):
         super(ApplicationCollection, self).__init__(context, Application, resource_path)
+
+    def add(self, displayName):
+        """
+        Create a new application object.
+        :type displayName: str
+        """
+        return self.add_from_json({"displayName": displayName})

office365/directory/directory.py

@@ -8,27 +8,28 @@ class Directory(Entity):
     "container". Deleted items will remain available to restore for up to 30 days. After 30 days, the items are
     permanently deleted. """
 
-    def get_deleted_items(self, entity_type=None):
+    def deleted_items(self, entity_type=None):
         """Recently deleted items. Read-only. Nullable."""
-        if self.is_property_available('deletedItems'):
-            return self.properties['deletedItems']
+        if entity_type:
+            return DirectoryObjectCollection(self.context, ResourcePath(entity_type,
+                                                                        ResourcePath("deletedItems",
+                                                                                     self.resource_path)))
         else:
-            res_path = entity_type and \
-                ResourcePath(entity_type, ResourcePath("deletedItems", self.resource_path)) or \
-                ResourcePath("deletedItems", self.resource_path)
-            return DirectoryObjectCollection(self.context, res_path)
+            return self.properties.get('deletedItems',
+                                       DirectoryObjectCollection(self.context,
+                                                                 ResourcePath("deletedItems", self.resource_path)))
 
     @property
-    def deletedGroups(self):
+    def deleted_groups(self):
         """Recently deleted groups"""
-        return self.get_deleted_items("microsoft.graph.group")
+        return self.deleted_items("microsoft.graph.group")
 
     @property
-    def deletedUsers(self):
+    def deleted_users(self):
         """Recently deleted users"""
-        return self.get_deleted_items("microsoft.graph.user")
+        return self.deleted_items("microsoft.graph.user")
 
     @property
-    def deletedApplications(self):
+    def deleted_applications(self):
         """Recently deleted applications"""
-        return self.get_deleted_items("microsoft.graph.application")
+        return self.deleted_items("microsoft.graph.application")

office365/directory/directoryObject.py

@@ -1,14 +1,25 @@
 from office365.entity import Entity
 from office365.runtime.client_result import ClientResult
-from office365.runtime.queries.delete_entity_query import DeleteEntityQuery
 from office365.runtime.queries.service_operation_query import ServiceOperationQuery
-from office365.runtime.queries.update_entity_query import UpdateEntityQuery
 
 
 class DirectoryObject(Entity):
     """Represents an Azure Active Directory object. The directoryObject type is the base type for many other
     directory entity types. """
 
+    def get_member_objects(self, security_enabled_only=True):
+        """Returns all the groups and directory roles that a user, group, or directory object is a member of.
+        This function is transitive.
+
+        :type security_enabled_only: bool"""
+        result = ClientResult(None)
+        payload = {
+            "securityEnabledOnly": security_enabled_only
+        }
+        qry = ServiceOperationQuery(self, "getMemberObjects", None, payload, None, result)
+        self.context.add_query(qry)
+        return result
+
     def get_member_groups(self, security_enabled_only=True):
         """Return all the groups that the specified user, group, or directory object is a member of. This function is
         transitive.
@@ -23,11 +34,9 @@ def get_member_groups(self, security_enabled_only=True):
         return result
 
     @property
-    def deletedDateTime(self):
+    def deleted_datetime(self):
         """ETag for the item."""
-        if self.is_property_available("deletedDateTime"):
-            return self.properties['deletedDateTime']
-        return None
+        return self.properties.get('deletedDateTime', None)
 
     def set_property(self, name, value, persist_changes=True):
         super(DirectoryObject, self).set_property(name, value, persist_changes)

office365/directory/directoryObjectCollection.py

@@ -20,16 +20,10 @@ def get(self):
 
     def __getitem__(self, key):
         """
-
-        :param key: key is used to address a DirectoryObject resource by either an index in collection
-        or by resource id
         :type key: int or str
         :rtype: DirectoryObject
         """
-        if type(key) == int:
-            return super(DirectoryObjectCollection, self).__getitem__(key)
-        return self._item_type(self.context,
-                               ResourcePath(key, self.resource_path))
+        return super(DirectoryObjectCollection, self).__getitem__(key)
 
     def getByIds(self, ids):
         """Returns the directory objects specified in a list of IDs."""

office365/directory/group.py

@@ -1,6 +1,7 @@
 import json
 
 from office365.calendar.event_collection import EventCollection
+from office365.directory.appRoleAssignment import AppRoleAssignmentCollection
 from office365.directory.directoryObject import DirectoryObject
 from office365.directory.directoryObjectCollection import DirectoryObjectCollection
 from office365.onedrive.driveCollection import DriveCollection
@@ -16,10 +17,18 @@ class Group(DirectoryObject):
     """Represents an Azure Active Directory (Azure AD) group, which can be an Office 365 group, or a security group."""
 
     def subscribe_by_mail(self):
-        pass
+        """Calling this method will enable the current user to receive email notifications for this group,
+        about new posts, events, and files in that group. Supported for Microsoft 365 groups only."""
+        qry = ServiceOperationQuery(self, "subscribeByMail")
+        self.context.add_query(qry)
+        return self
 
     def unsubscribe_by_mail(self):
-        pass
+        """Calling this method will prevent the current user from receiving email notifications for this group
+        about new posts, events, and files in that group. Supported for Microsoft 365 groups only."""
+        qry = ServiceOperationQuery(self, "unsubscribeByMail")
+        self.context.add_query(qry)
+        return self
 
     def check_member_groups(self, group_ids):
         """Check for membership in the specified list of groups. Returns from the list those groups of which
@@ -49,6 +58,7 @@ def _construct_create_team_request(request):
                 request.method = HttpMethod.Put
                 request.set_header('Content-Type', "application/json")
                 request.data = json.dumps(request.data)
+
         self.context.before_execute(_construct_create_team_request, False)
         return team
 
@@ -60,7 +70,7 @@ def delete_object(self, permanent_delete=False):
         """
         super(Group, self).delete_object()
         if permanent_delete:
-            deleted_item = self.context.directory.deletedGroups[self.id]
+            deleted_item = self.context.directory.deleted_groups[self.id]
             deleted_item.delete_object()
         return self
 
@@ -92,3 +102,10 @@ def sites(self):
     def events(self):
         """Get an event collection or an event."""
         return self.properties.get('events', EventCollection(self.context, ResourcePath("events", self.resource_path)))
+
+    @property
+    def appRoleAssignments(self):
+        """Get an event collection or an appRoleAssignments."""
+        return self.properties.get('appRoleAssignments',
+                                   AppRoleAssignmentCollection(self.context,
+                                                               ResourcePath("appRoleAssignments", self.resource_path)))

office365/directory/groupSettingTemplateCollection.py

@@ -1,10 +1,8 @@
-from office365.directory.directoryObjectCollection import DirectoryObjectCollection
 from office365.directory.groupSettingTemplate import GroupSettingTemplate
+from office365.entity_collection import EntityCollection
 
 
-class GroupSettingTemplateCollection(DirectoryObjectCollection):
-    """User's collection"""
+class GroupSettingTemplateCollection(EntityCollection):
 
     def __init__(self, context, resource_path=None):
-        super(GroupSettingTemplateCollection, self).__init__(context, resource_path)
-        self._item_type = GroupSettingTemplate
+        super(GroupSettingTemplateCollection, self).__init__(context, GroupSettingTemplate, resource_path)