refactor auth module, new types for tenant namespace

Author: vgrem

README.md

@@ -93,7 +93,7 @@ Steps to access:
    - [Granting access via Azure AD App-Only](https://docs.microsoft.com/en-us/sharepoint/dev/solution-guidance/security-apponly-azuread)  
    - [wiki](https://github.com/vgrem/Office365-REST-Python-Client/wiki/How-to-connect-to-SharePoint-Online-with-certificate-credentials) 
   
-  Example: [connect_with_client_certificate.py](examples/sharepoint/auth_client_certificate.py)
+  Example: [with_certificate.py](examples/sharepoint/auth_certificate.py)
 
 #### 4. Interactive
 

examples/sharepoint/auth_client_certificate.py examples/sharepoint/auth_certificate.py

@@ -26,13 +26,13 @@ def export_to_file(path, content):
     "--endpoint",
     dest="endpoint",
     help="Import metadata endpoint",
-    default="graph",
+    default="sharepoint",
 )
 parser.add_argument(
     "-p",
     "--path",
     dest="path",
-    default="./metadata/Graph.xml",
+    default="./metadata/SharePoint.xml",
     help="Import metadata endpoint",
 )
 

examples/sharepoint/auth_client_certificate_adal.py examples/sharepoint/auth_certificate_adal.py

@@ -2,7 +2,7 @@
 import sys
 from typing import Any, Callable
 
-from typing_extensions import Required, TypedDict
+from typing_extensions import Required, Self, TypedDict
 
 from office365.runtime.auth.client_credential import ClientCredential
 from office365.runtime.auth.providers.acs_token_provider import ACSTokenProvider
@@ -211,12 +211,14 @@ def with_credentials(self, credentials):
             raise ValueError("Unknown credential type")
 
         def _authenticate(request):
+            # type: (RequestOptions) -> None
             provider.authenticate_request(request)
 
         self._authenticate = _authenticate
         return self
 
     def acquire_token_for_user(self, username, password):
+        # type: (str, str) -> Self
         """
         Initializes a client to acquire a token via user credentials
         Status: deprecated!
@@ -227,6 +229,7 @@ def acquire_token_for_user(self, username, password):
         provider = SamlTokenProvider(self.url, username, password, self._browser_mode)
 
         def _authenticate(request):
+            # type: (RequestOptions) -> None
             provider.authenticate_request(request)
 
         self._authenticate = _authenticate
@@ -244,6 +247,7 @@ def acquire_token_for_app(self, client_id, client_secret):
         provider = ACSTokenProvider(self.url, client_id, client_secret)
 
         def _authenticate(request):
+            # type: (RequestOptions) -> None
             provider.authenticate_request(request)
 
         self._authenticate = _authenticate

examples/sharepoint/auth_client_certificate_passphrase.py examples/sharepoint/auth_certificate_passphrase.py

@@ -31,14 +31,9 @@ def __init__(self, url, client_id, client_secret, environment="commercial"):
 
     def authenticate_request(self, request):
         # type: (RequestOptions) -> None
-        self.ensure_app_only_access_token()
+        self._ensure_app_only_access_token()
         request.set_header("Authorization", self._get_authorization_header())
 
-    def ensure_app_only_access_token(self):
-        if self._cached_token is None:
-            self._cached_token = self.get_app_only_access_token()
-        return self._cached_token and self._cached_token.is_valid
-
     def get_app_only_access_token(self):
         """Retrieves an app-only access token from ACS"""
         try:
@@ -53,6 +48,11 @@ def get_app_only_access_token(self):
             )
             raise ValueError(self.error)
 
+    def _ensure_app_only_access_token(self):
+        if self._cached_token is None:
+            self._cached_token = self.get_app_only_access_token()
+        return self._cached_token and self._cached_token.is_valid
+
     def _get_app_only_access_token(self, target_host, target_realm):
         """
         Retrieves an app-only access token from ACS to call the specified principal
@@ -119,6 +119,3 @@ def get_security_token_service_url(realm, environment):
 
     def _get_authorization_header(self):
         return "Bearer {0}".format(self._cached_token.accessToken)
-
-    def get_last_error(self):
-        return self.error

examples/sharepoint/auth_client_certificate_private_key.py examples/sharepoint/auth_certificate_private_key.py

@@ -132,9 +132,6 @@ def _get_user_realm(self):
             return info
         return None
 
-    def get_last_error(self):
-        return self.error
-
     def _acquire_service_token_from_adfs(self, adfs_url):
         logger = self.logger(self._acquire_service_token_from_adfs.__name__)
 
@@ -312,19 +309,16 @@ def _get_authentication_cookie(self, security_token, federated=False):
             raise ValueError(self.error)
         return cookies
 
-    @staticmethod
-    def _prepare_request_from_template(template_name, params):
+    def _prepare_request_from_template(self, template_name, params):
         """Construct the request body to acquire security token from STS endpoint"""
-        logger = SamlTokenProvider.logger()
+        logger = self.logger(self._prepare_request_from_template.__name__)
         logger.debug_secrets("params: %s", params)
-        f = open(
-            os.path.join(os.path.dirname(__file__), "templates", template_name),
-            encoding="utf8",
+
+        template_path = os.path.join(
+            os.path.dirname(__file__), "templates", template_name
         )
-        try:
+
+        with open(template_path, encoding="utf8") as f:
             data = f.read()
-            for key in params:
-                data = data.replace("{" + key + "}", str(params[key]))
-            return data
-        finally:
-            f.close()
+
+        return data.format(**params)

examples/sharepoint/auth_client_certificate_scopes.py examples/sharepoint/auth_certificate_scopes.py

@@ -0,0 +1,5 @@
+from office365.runtime.client_value import ClientValue
+
+
+class CustomFontsResource(ClientValue):
+    """ """

generator/import_metadata.py

@@ -0,0 +1,27 @@
+from office365.runtime.client_result import ClientResult
+from office365.runtime.queries.service_operation import ServiceOperationQuery
+from office365.sharepoint.entity import Entity
+
+
+class PolicyLicenseUtilities(Entity):
+    """"""
+
+    @staticmethod
+    def check_tenant_m365_copilot_business_chat_license(context, return_type=None):
+        """"""
+        if return_type is None:
+            return_type = ClientResult(context, bool())
+        qry = ServiceOperationQuery(
+            PolicyLicenseUtilities(context),
+            "CheckTenantM365CopilotBusinessChatLicense",
+            None,
+            None,
+            None,
+            return_type,
+        )
+        context.add_query(qry)
+        return return_type
+
+    @property
+    def entity_type_name(self):
+        return "SP.Utilities.PolicyLicenseUtilities"

generator/metadata/SharePoint.xml

@@ -27,6 +27,7 @@ def access_request_settings(self):
 
     @property
     def anonymous_link_expiration_restriction_days(self):
+        # type: () -> Optional[int]
         """Tenant's anonymous link expiration restriction in days."""
         return self.properties.get("anonymousLinkExpirationRestrictionDays", None)
 

office365/runtime/auth/authentication_context.py

@@ -1,7 +1,19 @@
 from office365.runtime.client_value import ClientValue
+from office365.runtime.client_value_collection import ClientValueCollection
+from office365.sharepoint.tenant.administration.modified_property import (
+    ModifiedProperty,
+)
 
 
 class AuditData(ClientValue):
+
+    def __init__(self, client_ip=None, correlation_id=None, modified_properties=None):
+        self.ClientIP = client_ip
+        self.CorrelationId = correlation_id
+        self.ModifiedProperties = ClientValueCollection(
+            ModifiedProperty, modified_properties
+        )
+
     @property
     def entity_type_name(self):
         return "Microsoft.SharePoint.Administration.TenantAdmin.AuditData"

office365/runtime/auth/providers/acs_token_provider.py

@@ -1,7 +1,25 @@
 from office365.runtime.client_value import ClientValue
+from office365.sharepoint.tenant.administration.audit.data import AuditData
 
 
 class UnifiedAuditRecord(ClientValue):
+
+    def __init__(
+        self,
+        audit_data=AuditData(),
+        creation_date=None,
+        operation=None,
+        record_id=None,
+        record_type=None,
+        user_id=None,
+    ):
+        self.AuditData = audit_data
+        self.CreationDate = creation_date
+        self.Operation = operation
+        self.RecordId = record_id
+        self.RecordType = record_type
+        self.UserId = user_id
+
     @property
     def entity_type_name(self):
         return "Microsoft.SharePoint.Administration.TenantAdmin.UnifiedAuditRecord"

office365/runtime/auth/providers/saml_token_provider.py

@@ -0,0 +1,5 @@
+from office365.runtime.client_value import ClientValue
+
+
+class MessagesFieldsData(ClientValue):
+    """ """

office365/sharepoint/administration/custom_fonts_resource.py

@@ -0,0 +1,16 @@
+from office365.runtime.paths.resource_path import ResourcePath
+from office365.sharepoint.entity import Entity
+
+
+class Office365CommsMessagesServiceProxy(Entity):
+    """"""
+
+    def __init__(self, context):
+        static_path = ResourcePath(
+            "Microsoft.Online.SharePoint.TenantAdministration.Office365CommsMessagesServiceProxy"
+        )
+        super(Office365CommsMessagesServiceProxy, self).__init__(context, static_path)
+
+    @property
+    def entity_type_name(self):
+        return "Microsoft.Online.SharePoint.TenantAdministration.Office365CommsMessagesServiceProxy"

office365/sharepoint/policy/license_utilities.py

@@ -20,7 +20,7 @@ class SPDataGovernanceInsightRestApiClient(SPDataGovernanceRestApiClientBase):
     def __init__(self, context, authorization_header, url, user_agent):
         # type: (ClientContext, str, str, str) -> None
         static_path = ServiceOperationPath(
-            "SP.AppContextSite",
+            "Microsoft.Online.SharePoint.TenantAdministration.SPDataGovernanceInsightRestApiClient",
             {
                 "authorizationHeader": authorization_header,
                 "url": url,

office365/sharepoint/sharing/information.py

@@ -0,0 +1,5 @@
+from office365.runtime.client_value import ClientValue
+
+
+class ModifiedProperty(ClientValue):
+    """"""

office365/sharepoint/tenant/administration/audit/data.py

@@ -0,0 +1,9 @@
+from office365.runtime.client_value import ClientValue
+
+
+class TenantAdminRecentAction(ClientValue):
+    """"""
+
+    @property
+    def entity_type_name(self):
+        return "Microsoft.SharePoint.Administration.TenantAdmin.TenantAdminRecentAction"

office365/sharepoint/tenant/administration/audit/unified_record.py

@@ -10,6 +10,8 @@
 from office365.sharepoint.tenant.administration.types import (
     AutoQuotaEnabled,
     DisableGroupify,
+    DisableSelfServiceSiteCreation,
+    EnableAutoNewsDigest,
 )
 
 
@@ -56,6 +58,18 @@ def disable_groupify(self):
         """
         return self.properties.get("DisableGroupify", DisableGroupify())
 
+    @property
+    def disable_self_service_site_creation(self):
+        """ " """
+        return self.properties.get(
+            "DisableSelfServiceSiteCreation", DisableSelfServiceSiteCreation()
+        )
+
+    @property
+    def enable_auto_news_digest(self):
+        """ " """
+        return self.properties.get("EnableAutoNewsDigest", EnableAutoNewsDigest())
+
     @property
     def smtp_server(self):
         """Specifies the server address or endpoint of the SMTP server that SharePoint Online or tenant-related
@@ -75,6 +89,10 @@ def get_property(self, name, default_value=None):
         if default_value is None:
             property_mapping = {
                 "AvailableManagedPathsForSiteCreation": self.available_managed_paths_for_site_creation,
+                "AutoQuotaEnabled": self.auto_quota_enabled,
+                "DisableGroupify": self.disable_groupify,
+                "DisableSelfServiceSiteCreation": self.disable_self_service_site_creation,
+                "EnableAutoNewsDigest": self.enable_auto_news_digest,
                 "SmtpServer": self.smtp_server,
                 "TenantDefaultTimeZoneId": self.tenant_default_time_zone_id,
             }

office365/sharepoint/tenant/administration/coms/__init__.py

@@ -825,6 +825,16 @@ def migration_center(self):
 
         return MigrationCenterServices(self.context)
 
+    @property
+    def comms_messages(self):
+        """ """
+
+        from office365.sharepoint.tenant.administration.coms.messages_service_proxy import (
+            Office365CommsMessagesServiceProxy,
+        )
+
+        return Office365CommsMessagesServiceProxy(self.context)
+
     @property
     def multi_geo(self):
         """ """