🔍 Code Extractor

IdentitySet is a keyed collection class that represents a set of identity resources (application, device, user) associated with various events for an item, such as created by or last modified by actions.

Purpose

This class serves as a container for tracking multiple identity types associated with an action or event in Microsoft Office 365 services. It groups together application, device, and user identities to provide comprehensive context about who or what performed an action. It inherits from ClientValue, making it suitable for serialization and transmission in API calls to Office 365 services.

Source Code

class IdentitySet(ClientValue):
    """The IdentitySet resource is a keyed collection of identity resources. It is used to represent a set of
    identities associated with various events for an item, such as created by or last modified by.
    """

    def __init__(self, application=Identity(), device=Identity(), user=Identity()):
        """
        :param Identity application: The application associated with this action.
        :param Identity device: The device associated with this action.
        :param Identity user: The user associated with this action.
        """
        super(IdentitySet, self).__init__()
        self.application = application
        self.device = device
        self.user = user

    def __repr__(self):
        return repr({n: v.to_json() for n, v in self if v.to_json()})

Parameters

Parameter Details

application: An Identity object representing the application associated with the action. Defaults to an empty Identity() instance if not provided. Used to track which application performed or initiated the action.

device: An Identity object representing the device associated with the action. Defaults to an empty Identity() instance if not provided. Used to track which device was used for the action.

user: An Identity object representing the user associated with the action. Defaults to an empty Identity() instance if not provided. Used to track which user performed the action.

Return Value

Instantiation returns an IdentitySet object containing three Identity instances (application, device, user). The __repr__ method returns a dictionary representation where each identity is converted to JSON format, excluding empty identities.

Class Interface

Methods

Attributes

Dependencies

• office365.directory.permissions.identity
• office365.runtime.client_value

Required Imports

from office365.directory.permissions.identity import Identity
from office365.runtime.client_value import ClientValue

Usage Example

from office365.directory.permissions.identity import Identity
from office365.directory.permissions.identity_set import IdentitySet

# Create individual identities
user_identity = Identity()
app_identity = Identity()
device_identity = Identity()

# Create an IdentitySet with all identities
identity_set = IdentitySet(
    application=app_identity,
    device=device_identity,
    user=user_identity
)

# Create an IdentitySet with default empty identities
default_identity_set = IdentitySet()

# Access individual identities
user = identity_set.user
application = identity_set.application
device = identity_set.device

# Get string representation (JSON format)
print(identity_set)

Best Practices

• Always initialize with Identity objects rather than None to avoid potential AttributeErrors when accessing identity properties
• Use this class when tracking audit information or metadata about who/what performed actions in Office 365 services
• The class is iterable (inherits from ClientValue), allowing iteration over its identity attributes
• The __repr__ method automatically filters out empty identities (those that return empty JSON), making the representation cleaner
• This class is designed for serialization and should be used in contexts where data needs to be transmitted to/from Office 365 APIs
• Instantiate with specific Identity objects when you have concrete identity information; use defaults for placeholder scenarios

Tags

Similar Components

AI-powered semantic similarity - components with related functionality:

• class Identity 75.6% similar

  The Identity class represents an identity of an actor (user, device, or application) in the Microsoft Office 365 API, storing display name and unique identifier information.

  From: /tf/active/vicechatdev/SPFCsync/venv/lib64/python3.11/site-packages/office365/directory/permissions/identity.py

• class InsightIdentity 70.6% similar

  InsightIdentity is a data class that represents the identity properties of sharedInsight items in Microsoft Office 365 services.

  From: /tf/active/vicechatdev/SPFCsync/venv/lib64/python3.11/site-packages/office365/directory/insights/identity.py

• class ObjectIdentity 64.3% similar

  Represents an identity used to sign in to a user account, encapsulating sign-in type, issuer, and issuer-assigned identifier information.

  From: /tf/active/vicechatdev/SPFCsync/venv/lib64/python3.11/site-packages/office365/directory/identities/object_identity.py

• class ActivityIdentity 62.9% similar

  ActivityIdentity represents an identity associated with a SharePoint activity, containing client identification and associated user and group identity items.

  From: /tf/active/vicechatdev/SPFCsync/venv/lib64/python3.11/site-packages/office365/sharepoint/activities/identity.py

• class AppIdentity 62.0% similar

  A data class representing the identity of an Azure Active Directory application that performed an action or was changed, used in directory audit operations.

  From: /tf/active/vicechatdev/SPFCsync/venv/lib64/python3.11/site-packages/office365/directory/applications/app_identity.py