directory namespace enhancements: new types & methods

Author: vgrem

examples/onedrive/export_term_store.py

@@ -1,10 +1,8 @@
-import json
-
 from examples import acquire_token_by_client_credentials
 from office365.graph_client import GraphClient
 from tests import test_team_site_url
 
 client = GraphClient(acquire_token_by_client_credentials)
 term_sets = client.sites.get_by_url(test_team_site_url).term_store.get_all_term_sets().execute_query()
-term_sets_json = [ts.properties for ts in term_sets]
-print(json.dumps(term_sets_json))
+names = [ts.localized_names[0].name for ts in term_sets]
+print(names)

generator/metadata/SharePoint.xml

@@ -2,4 +2,7 @@
 
 
 class AppIdentity(ClientValue):
+    """Indicates the identity of the application that performed the action or was changed.
+    Includes application ID, name, and service principal ID and name. This resource is used by the
+    Get directoryAudit operation."""
     pass

office365/directory/applications/app_identity.py

@@ -1,17 +1,78 @@
+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.permissions.scope import PermissionScope
+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.service_operation import ServiceOperationQuery
 
 
 class ServicePrincipal(DirectoryObject):
     """Represents an instance of an application in a directory."""
 
     def add_key(self, key_credential, password_credential, proof):
-        pass
+        """
+        Adds a key credential to a servicePrincipal. This method along with removeKey can be used by a servicePrincipal
+        to automate rolling its expiring keys.
+
+        :param KeyCredential key_credential: The new application key credential to add.
+            The type, usage and key are required properties for this usage. Supported key types are:
+                AsymmetricX509Cert: The usage must be Verify.
+                X509CertAndPassword: The usage must be Sign
+        :param PasswordCredential password_credential: Only secretText is required to be set which should contain the password
+             for the key. This property is required only for keys of type X509CertAndPassword. Set it to null otherwise.
+        :param str proof: A self-signed JWT token used as a proof of possession of the existing keys
+        """
+        payload = {
+            "keyCredential": key_credential,
+            "passwordCredential": password_credential,
+            "proof": proof,
+        }
+        return_type = ClientResult(self.context, KeyCredential())
+        qry = ServiceOperationQuery(self, "addKey", None, payload, None, return_type)
+        self.context.add_query(qry)
+        return return_type
 
     def add_password(self):
+        """"""
         pass
 
+    def add_token_signing_certificate(self, display_name, end_datetime=None):
+        """
+        Create a self-signed signing certificate and return a selfSignedCertificate object, which is the public part
+        of the generated certificate.
+
+        The self-signed signing certificate is composed of the following objects,
+        which are added to the servicePrincipal:
+
+          The keyCredentials object with the following objects:
+              A private key object with usage set to Sign.
+              A public key object with usage set to Verify.
+              The passwordCredentials object.
+        All the objects have the same value of customKeyIdentifier.
+
+        The passwordCredential is used to open the PFX file (private key). It and the associated private key object
+        have the same value of keyId. When set during creation through the displayName property, the subject of the
+        certificate cannot be updated. The startDateTime is set to the same time the certificate is created using
+        the action. The endDateTime can be up to three years after the certificate is created.
+
+        :param str display_name: Friendly name for the key. It must start with CN=.
+        :param str end_datetime: The date and time when the credential expires. It can be up to 3 years from the date
+            the certificate is created. If not supplied, the default is three years from the time of creation.
+            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.
+        """
+        payload = {
+            "displayName": display_name,
+            "endDateTime": end_datetime
+        }
+        return_type = ClientResult(self.context, SelfSignedCertificate())
+        qry = ServiceOperationQuery(self, "addTokenSigningCertificate", None, payload, None, return_type)
+        self.context.add_query(qry)
+        return return_type
+
     @property
     def app_display_name(self):
         """The collection of key credentials associated with the application. Not nullable.
@@ -47,8 +108,22 @@ def service_principal_type(self):
     def owners(self):
         """Directory objects that are owners of this servicePrincipal.
         The owners are a set of non-admin users or servicePrincipals who are allowed to modify this object.
+        """
+        return self.properties.get('owners',
+                                   DirectoryObjectCollection(self.context, ResourcePath("owners", self.resource_path)))
 
-        :rtype: DirectoryObjectCollection
+    @property
+    def oauth2_permission_scopes(self):
+        """
+        The delegated permissions exposed by the application. For more information see the oauth2PermissionScopes
+        property on the application entity's api property.
         """
-        return self.get_property('owners',
-                                 DirectoryObjectCollection(self.context, ResourcePath("owners", self.resource_path)))
+        return self.properties.get("oauth2PermissionScopes", ClientValueCollection(PermissionScope))
+
+    def get_property(self, name, default_value=None):
+        if default_value is None:
+            property_mapping = {
+                "oauth2PermissionScopes": self.oauth2_permission_scopes
+            }
+            default_value = property_mapping.get(name, None)
+        return super(ServicePrincipal, self).get_property(name, default_value)

office365/directory/applications/public_client_application.py renamed to office365/directory/applications/public_client.py

@@ -1,4 +1,4 @@
-from office365.directory.certificates.certificate_authority import CertificateAuthority
+from office365.directory.certificates.authority import CertificateAuthority
 from office365.entity import Entity
 from office365.runtime.client_value_collection import ClientValueCollection