directory namespace enhancements: new types & methods

vgrem · vgrem · commit 75b1fee2021c · 2022-12-01T22:47:36.000+02:00
diff --git a/examples/sharepoint/connect_and_set_proxy.py b/examples/sharepoint/connect_and_set_proxy.py
@@ -8,8 +8,8 @@
 
 def set_proxy(request):
     print("Inject proxy settings...")
-    proxies = {settings.get('default', 'site_url'): 'https://127.0.0.1:8888'}
-    request.proxies = proxies
+    #proxies = {settings.get('default', 'site_url'): 'https://127.0.0.1:8888'}
+    #request.proxies = proxies
 
 
 ctx = ClientContext(settings.get('default', 'site_url'))\
diff --git a/office365/directory/applications/application.py b/office365/directory/applications/application.py
@@ -1,3 +1,4 @@
+from office365.directory.applications.public_client import PublicClientApplication
 from office365.directory.object_collection import DirectoryObjectCollection
 from office365.directory.object import DirectoryObject
 from office365.directory.extensions.extension_property import ExtensionProperty
@@ -137,6 +138,13 @@ def identifier_uris(self):
         """
         return self.properties.get('identifierUris', StringCollection())
 
+    @property
+    def public_client(self):
+        """
+        Specifies settings for installed clients such as desktop or mobile devices.
+        """
+        return self.properties.get('publicClient', PublicClientApplication())
+
     @property
     def signin_audience(self):
         """
@@ -149,20 +157,33 @@ def signin_audience(self):
         return self.properties.get('signInAudience', None)
 
     @property
-    def owners(self):
-        """Directory objects that are owners of the application. Read-only.
+    def created_on_behalf_of(self):
+        """"""
+        return self.properties.get('createdOnBehalfOf',
+                                   DirectoryObject(self.context, ResourcePath("createdOnBehalfOf", self.resource_path)))
 
-        :rtype: DirectoryObjectCollection
+    @property
+    def owners(self):
+        """Directory objects that are owners of the application.
         """
-        return self.get_property('owners',
-                                 DirectoryObjectCollection(self.context, ResourcePath("owners", self.resource_path)))
+        return self.properties.get('owners',
+                                   DirectoryObjectCollection(self.context, ResourcePath("owners", self.resource_path)))
 
     @property
     def extension_properties(self):
         """List extension properties on an application object.
-
-        :rtype: EntityCollection
         """
-        return self.get_property('extensionProperties',
-                                 EntityCollection(self.context, ExtensionProperty,
-                                                  ResourcePath("extensionProperties", self.resource_path)))
+        return self.properties.get('extensionProperties',
+                                   EntityCollection(self.context, ExtensionProperty,
+                                                    ResourcePath("extensionProperties", self.resource_path)))
+
+    def get_property(self, name, default_value=None):
+        if default_value is None:
+            property_mapping = {
+                "createdOnBehalfOf": self.created_on_behalf_of,
+                "extensionProperties": self.extension_properties,
+                "keyCredentials": self.key_credentials,
+                "publicClient": self.public_client
+            }
+            default_value = property_mapping.get(name, None)
+        return super(Application, self).get_property(name, default_value)
diff --git a/office365/directory/applications/service_principal.py b/office365/directory/applications/service_principal.py
@@ -1,7 +1,9 @@
+from office365.directory.applications.app_role_assignment import AppRoleAssignmentCollection
 from office365.directory.certificates.self_signed import SelfSignedCertificate
 from office365.directory.key_credential import KeyCredential
 from office365.directory.object_collection import DirectoryObjectCollection
 from office365.directory.object import DirectoryObject
+from office365.directory.password_credential import PasswordCredential
 from office365.directory.permissions.scope import PermissionScope
 from office365.runtime.client_result import ClientResult
 from office365.runtime.client_value_collection import ClientValueCollection
@@ -35,9 +37,16 @@ def add_key(self, key_credential, password_credential, proof):
         self.context.add_query(qry)
         return return_type
 
-    def add_password(self):
-        """"""
-        pass
+    def add_password(self, display_name=None):
+        """Adds a strong password to an application.
+
+        :param str display_name: App display name
+        """
+        params = PasswordCredential(display_name=display_name)
+        return_type = ClientResult(self.context, params)
+        qry = ServiceOperationQuery(self, "addPassword", None, params, None, return_type)
+        self.context.add_query(qry)
+        return return_type
 
     def add_token_signing_certificate(self, display_name, end_datetime=None):
         """
@@ -79,6 +88,15 @@ def app_display_name(self):
         """
         return self.properties.get('appDisplayName', None)
 
+    @property
+    def app_role_assigned_to(self):
+        """
+        App role assignments for this app or service, granted to users, groups, and other service principals.
+        Supports $expand."""
+        return self.properties.get('appRoleAssignedTo',
+                                   AppRoleAssignmentCollection(self.context,
+                                                               ResourcePath("appRoleAssignedTo", self.resource_path)))
+
     @property
     def service_principal_type(self):
         """
@@ -120,10 +138,27 @@ def oauth2_permission_scopes(self):
         """
         return self.properties.get("oauth2PermissionScopes", ClientValueCollection(PermissionScope))
 
+    @property
+    def created_objects(self):
+        """Directory objects created by this service principal. """
+        return self.properties.get('createdObjects',
+                                   DirectoryObjectCollection(self.context,
+                                                             ResourcePath("createdObjects", self.resource_path)))
+
+    @property
+    def owned_objects(self):
+        """Directory objects that are owned by this service principal. """
+        return self.properties.get('ownedObjects',
+                                   DirectoryObjectCollection(self.context,
+                                                             ResourcePath("ownedObjects", self.resource_path)))
+
     def get_property(self, name, default_value=None):
         if default_value is None:
             property_mapping = {
-                "oauth2PermissionScopes": self.oauth2_permission_scopes
+                "app_role_assigned_to": self.app_role_assigned_to,
+                "created_objects": self.created_objects,
+                "oauth2PermissionScopes": self.oauth2_permission_scopes,
+                "ownedObjects": self.owned_objects
             }
             default_value = property_mapping.get(name, None)
         return super(ServicePrincipal, self).get_property(name, default_value)
diff --git a/office365/directory/authentication/basic.py b/office365/directory/authentication/basic.py
@@ -1,4 +1,4 @@
-from office365.directory.identities.authentication_configuration_base import ApiAuthenticationConfigurationBase
+from office365.directory.authentication.configuration_base import ApiAuthenticationConfigurationBase
 
 
 class BasicAuthentication(ApiAuthenticationConfigurationBase):
diff --git a/office365/directory/authentication/client_certificate.py b/office365/directory/authentication/client_certificate.py
@@ -0,0 +1,15 @@
+from office365.directory.authentication.configuration_base import ApiAuthenticationConfigurationBase
+from office365.directory.certificates.pkcs12_information import Pkcs12CertificateInformation
+from office365.runtime.client_value_collection import ClientValueCollection
+
+
+class ClientCertificateAuthentication(ApiAuthenticationConfigurationBase):
+    """
+    A type derived from apiAuthenticationConfigurationBase that is used to represent
+    a Pkcs12-based client certificate authentication.
+    This is used to retrieve the public properties of uploaded certificates.
+    """
+
+    def __init__(self):
+        super().__init__()
+        self.certificateList = ClientValueCollection(Pkcs12CertificateInformation)
diff --git a/office365/directory/authentication/configuration_base.py b/office365/directory/authentication/configuration_base.py
diff --git a/office365/directory/certificates/pkcs12_information.py b/office365/directory/certificates/pkcs12_information.py
@@ -0,0 +1,5 @@
+from office365.runtime.client_value import ClientValue
+
+
+class Pkcs12CertificateInformation(ClientValue):
+    """"""
diff --git a/office365/directory/extensions/extended_property.py b/office365/directory/extensions/extended_property.py
@@ -1,4 +1,5 @@
 from office365.entity import Entity
+from office365.runtime.types.collections import StringCollection
 
 
 class SingleValueLegacyExtendedProperty(Entity):
@@ -8,4 +9,8 @@ class SingleValueLegacyExtendedProperty(Entity):
 
 class MultiValueLegacyExtendedProperty(Entity):
     """An extended property that contains a collection of values."""
-    pass
+
+    @property
+    def value(self):
+        """A collection of property values."""
+        return self.properties.get("value", StringCollection())
diff --git a/office365/directory/identities/api_connector.py b/office365/directory/identities/api_connector.py
@@ -1,4 +1,4 @@
-from office365.directory.identities.authentication_configuration_base import ApiAuthenticationConfigurationBase
+from office365.directory.authentication.configuration_base import ApiAuthenticationConfigurationBase
 from office365.entity import Entity
 from office365.runtime.queries.service_operation import ServiceOperationQuery
 
diff --git a/office365/directory/roles/role.py b/office365/directory/roles/role.py
@@ -8,10 +8,8 @@ class DirectoryRole(DirectoryObject):
     @property
     def members(self):
         """
-        Users that are members of this directory role. HTTP Methods: GET, POST, DELETE. Read-only. Nullable.
-
-        :rtype: office365.directory.object_collection.DirectoryObjectCollection
+        Users that are members of this directory role.
         """
         from office365.directory.object_collection import DirectoryObjectCollection
-        return self.get_property('members',
-                                 DirectoryObjectCollection(self.context, ResourcePath("members", self.resource_path)))
+        return self.properties.get('members',
+                                   DirectoryObjectCollection(self.context, ResourcePath("members", self.resource_path)))
diff --git a/office365/directory/users/user.py b/office365/directory/users/user.py
@@ -502,8 +502,6 @@ def planner(self):
     @property
     def extensions(self):
         """The collection of open extensions defined for the user. Nullable.
-
-        :rtype: EntityCollection
         """
         return self.properties.get('extensions',
                                    EntityCollection(self.context, Extension,
@@ -513,8 +511,6 @@ def extensions(self):
     def direct_reports(self):
         """
         Get a user's direct reports.
-
-        :rtype: EntityCollection
         """
         return self.properties.get('directReports',
                                    DirectoryObjectCollection(self.context,
@@ -524,8 +520,6 @@ def direct_reports(self):
     def online_meetings(self):
         """
         Get a user's online meetings.
-
-        :rtype: OnlineMeetingCollection
         """
         return self.properties.get('onlineMeetings',
                                    OnlineMeetingCollection(self.context,
diff --git a/office365/graph_client.py b/office365/graph_client.py
@@ -15,6 +15,7 @@
 from office365.directory.licenses.subscribed_sku import SubscribedSku
 from office365.directory.resource_specific_permission_grant import ResourceSpecificPermissionGrant
 from office365.directory.roles.management import RoleManagement
+from office365.directory.roles.role import DirectoryRole
 from office365.intune.organizations.org_contact import OrgContact
 from office365.intune.organizations.organization import Organization
 from office365.directory.policies.root import PolicyRoot
@@ -144,7 +145,7 @@ def teams(self):
 
     @property
     def chats(self):
-        """Get teams"""
+        """Get chats"""
         return ChatCollection(self, ResourcePath("chats"))
 
     @property
@@ -162,6 +163,11 @@ def directory(self):
         """Represents a deleted item in the directory"""
         return Directory(self, ResourcePath("directory"))
 
+    @property
+    def directory_roles(self):
+        """Represents a directory roles in the directory"""
+        return DeltaCollection(self, DirectoryRole, ResourcePath("directoryRoles"))
+
     @property
     def identity_providers(self):
         return EntityCollection(self, IdentityProvider, ResourcePath("identityProviders"))
diff --git a/office365/intune/organizations/organization.py b/office365/intune/organizations/organization.py
@@ -1,7 +1,11 @@
+from office365.directory.certificates.auth_configuration import CertificateBasedAuthConfiguration
 from office365.directory.object import DirectoryObject
 from office365.directory.extensions.extension import Extension
 from office365.entity_collection import EntityCollection
+from office365.intune.provisioned_plan import ProvisionedPlan
+from office365.runtime.client_value_collection import ClientValueCollection
 from office365.runtime.paths.resource_path import ResourcePath
+from office365.runtime.types.collections import StringCollection
 
 
 class Organization(DirectoryObject):
@@ -10,9 +14,40 @@ class Organization(DirectoryObject):
     which operate and are provisioned at the tenant-level.
     """
 
+    @property
+    def business_phones(self):
+        """
+        Telephone number for the organization. Although this is a string collection,
+        only one number can be set for this property.
+        """
+        return self.properties.get("businessPhones", StringCollection())
+
     @property
     def extensions(self):
         """The collection of open extensions defined for the message. Nullable."""
         return self.properties.get('extensions',
                                    EntityCollection(self.context, Extension,
                                                     ResourcePath("extensions", self.resource_path)))
+
+    @property
+    def certificate_based_auth_configuration(self):
+        """Navigation property to manage certificate-based authentication configuration.
+        Only a single instance of certificateBasedAuthConfiguration can be created in the collection.."""
+        return self.properties.get('certificateBasedAuthConfiguration',
+                                   EntityCollection(self.context, CertificateBasedAuthConfiguration,
+                                                    ResourcePath("certificateBasedAuthConfiguration",
+                                                                 self.resource_path)))
+
+    @property
+    def provisioned_plans(self):
+        return self.properties.get("provisionedPlans", ClientValueCollection(ProvisionedPlan))
+
+    def get_property(self, name, default_value=None):
+        if default_value is None:
+            property_mapping = {
+                "certificateBasedAuthConfiguration": self.certificate_based_auth_configuration,
+                "businessPhones": self.business_phones,
+                "provisionedPlans": self.provisioned_plans
+            }
+            default_value = property_mapping.get(name, None)
+        return super(Organization, self).get_property(name, default_value)
diff --git a/office365/intune/provisioned_plan.py b/office365/intune/provisioned_plan.py
@@ -0,0 +1,15 @@
+from office365.runtime.client_value import ClientValue
+
+
+class ProvisionedPlan(ClientValue):
+    """
+    The provisionedPlans property of the user entity and the organization entity is a collection of provisionedPlan.
+    """
+
+    def __init__(self, service=None):
+        self.service = service
+
+    def __repr__(self):
+        return self.service
+
+
diff --git a/office365/outlook/mail/messages/event_message.py b/office365/outlook/mail/messages/event_message.py
@@ -1,4 +1,5 @@
 from office365.outlook.mail.messages.message import Message
+from office365.outlook.mail.patterned_recurrence import PatternedRecurrence
 from office365.runtime.paths.resource_path import ResourcePath
 
 
@@ -14,3 +15,8 @@ def event(self):
         from office365.outlook.calendar.event import Event
         return self.properties.get('event',
                                    Event(self.context, ResourcePath("event", self.resource_path)))
+
+    @property
+    def patterned_recurrence(self):
+        """"""
+        return self.properties.get("patternedRecurrence", PatternedRecurrence())
diff --git a/office365/outlook/mail/patterned_recurrence.py b/office365/outlook/mail/patterned_recurrence.py
@@ -2,4 +2,12 @@
 
 
 class PatternedRecurrence(ClientValue):
+    """
+    The recurrence pattern and range. This shared object is used to define the recurrence of the following objects:
+
+        accessReviewScheduleDefinition objects in Azure AD access reviews APIs
+        event objects in the calendar API
+        unifiedRoleAssignmentScheduleRequest and unifiedRoleEligibilityScheduleRequest objects in PIM
+        accessPackageAssignment objects in Azure AD entitlement management.
+    """
     pass
diff --git a/tests/directory/test_directory.py b/tests/directory/test_directory.py
@@ -19,3 +19,7 @@ def test3_get_deleted_applications(self):
     def test4_get_member_objects(self):
         result = self.client.me.get_member_objects().execute_query()
         self.assertIsInstance(result.value, ClientValueCollection)
+
+    def test5_list_directory_roles(self):
+        result = self.client.directory_roles.get().execute_query()
+        self.assertIsNotNone(result.resource_path)
diff --git a/tests/directory/test_identity.py b/tests/directory/test_identity.py
@@ -0,0 +1,21 @@
+from unittest import TestCase
+
+from office365.graph_client import GraphClient
+from tests.graph_case import acquire_token_by_client_credentials
+
+
+class TestIdentity(TestCase):
+
+    @classmethod
+    def setUpClass(cls):
+        cls.client = GraphClient(acquire_token_by_client_credentials)
+
+    def test1_list_identity_providers(self):
+        result = self.client.identity.identity_providers.get().execute_query()
+        self.assertIsNotNone(result.resource_path)
+
+    def test2_list_user_flows(self):
+        result = self.client.identity.b2x_user_flows.get().execute_query()
+        self.assertIsNotNone(result.resource_path)
+
+

Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-from office365.directory.identities.authentication_configuration_base import ApiAuthenticationConfigurationBase`
	`1`	`+from office365.directory.authentication.configuration_base import ApiAuthenticationConfigurationBase`
`2`	`2`
`3`	`3`
`4`	`4`	`class BasicAuthentication(ApiAuthenticationConfigurationBase):`
-Original file line number
+Diff line change
@@ @@ -0,0 +1,5 @@ @@
 +from office365.runtime.client_value import ClientValue
++
++
 +class Pkcs12CertificateInformation(ClientValue):
 +    """"""